diff --git a/packages/ui-extensions/docs/surfaces/checkout/generated/checkout_ui_extensions/2026-04/targets.json b/packages/ui-extensions/docs/surfaces/checkout/generated/checkout_ui_extensions/2026-04/targets.json index 6fdb7a6ff7..8b17b8f43a 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/generated/checkout_ui_extensions/2026-04/targets.json +++ b/packages/ui-extensions/docs/surfaces/checkout/generated/checkout_ui_extensions/2026-04/targets.json @@ -6,6 +6,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -75,6 +76,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -144,6 +146,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -214,6 +217,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -283,6 +287,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -352,6 +357,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -421,6 +427,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -490,6 +497,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -559,6 +567,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -629,6 +638,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -698,6 +708,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -767,6 +778,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -836,6 +848,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -905,6 +918,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -974,6 +988,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1043,6 +1058,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1113,6 +1129,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1183,6 +1200,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1253,6 +1271,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1323,6 +1342,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1393,6 +1413,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1463,6 +1484,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1533,6 +1555,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1603,6 +1626,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1673,6 +1697,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1742,6 +1767,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1820,6 +1846,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1889,6 +1916,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -1968,6 +1996,7 @@ "Banner", "Box", "Button", + "Chat", "Checkbox", "Chip", "Choice", @@ -2334,6 +2363,41 @@ "purchase.thank-you.header.render-after" ] }, + "Chat": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, "Checkbox": { "targets": [ "purchase.checkout.actions.render-before", @@ -4182,12 +4246,6 @@ "purchase.thank-you.header.render-after" ] }, - "Chat": { - "targets": [ - "purchase.checkout.chat.render", - "purchase.thank-you.chat.render" - ] - }, "Announcement": { "targets": [ "purchase.thank-you.announcement.render" 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 7ce923ca3c..256fd5b846 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 @@ -17,7 +17,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_AddressApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -80,7 +79,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -316,7 +314,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -560,7 +557,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Checkout_AddressApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -577,7 +573,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -600,7 +595,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -845,14 +839,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -875,7 +867,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -898,7 +889,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -922,7 +912,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -1158,7 +1147,6 @@ "filePath": "src/surfaces/checkout/preact/billing-address.ts", "name": "UseBillingAddressGeneratedType", "description": "Returns the proposed `billingAddress` applied to the checkout.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/billing-address.ts", @@ -1172,7 +1160,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -1415,7 +1402,6 @@ "filePath": "src/surfaces/checkout/preact/shipping-address.ts", "name": "UseShippingAddressGeneratedType", "description": "Returns the proposed `shippingAddress` applied to the checkout.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/shipping-address.ts", @@ -1429,7 +1415,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -1680,7 +1665,6 @@ "filePath": "src/surfaces/checkout/preact/shipping-address.ts", "name": "UseApplyShippingAddressChangeGeneratedType", "description": "Returns a function to mutate the `shippingAddress` property of checkout.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/shipping-address.ts", @@ -1696,7 +1680,6 @@ "name": "ShippingAddressChange", "value": "ShippingAddressUpdateChange", "description": "The input for `applyShippingAddressChange()`. Currently only supports `ShippingAddressUpdateChange` (with `type: 'updateShippingAddress'`).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -1718,7 +1701,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -1963,14 +1945,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -1993,7 +1973,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2016,7 +1995,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2040,7 +2018,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -2312,14 +2289,13 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_AnalyticsApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." } ], "value": "export interface Docs_Standard_AnalyticsApi\n extends Pick {}" @@ -2327,39 +2303,36 @@ "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -2375,7 +2348,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -2389,10 +2361,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" } } } @@ -2472,7 +2444,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_AttributesApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -2526,7 +2497,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -2580,7 +2550,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Checkout_AttributesApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -2598,14 +2567,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2635,7 +2602,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -2682,7 +2648,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2706,14 +2671,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2729,7 +2692,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2759,7 +2721,6 @@ "filePath": "src/surfaces/checkout/preact/attributes.ts", "name": "UseApplyAttributeChangeGeneratedType", "description": "Returns a function to mutate the `attributes` property of the checkout.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/attributes.ts", @@ -2774,14 +2735,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2811,7 +2770,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -2858,7 +2816,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2882,14 +2839,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2905,7 +2860,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -2935,7 +2889,6 @@ "filePath": "src/surfaces/checkout/preact/attributes.ts", "name": "UseAttributesGeneratedType", "description": "Returns the proposed `attributes` applied to the checkout.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/attributes.ts", @@ -2949,7 +2902,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -3003,7 +2955,6 @@ "filePath": "src/surfaces/checkout/preact/attributes.ts", "name": "UseAttributeValuesGeneratedType", "description": "Returns the values for the specified `attributes` applied to the checkout.", - "isPublicDocs": true, "params": [ { "name": "keys", @@ -3099,7 +3050,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_BuyerIdentityApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -3116,7 +3066,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3191,7 +3140,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3303,7 +3251,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3327,7 +3274,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3362,7 +3308,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3404,7 +3349,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3427,7 +3371,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3470,7 +3413,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3520,7 +3462,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", @@ -3534,7 +3475,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3646,7 +3586,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3670,7 +3609,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3705,7 +3643,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3754,7 +3691,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", @@ -3775,7 +3711,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", @@ -3796,7 +3731,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", @@ -3810,7 +3744,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3833,7 +3766,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3876,7 +3808,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -3962,7 +3893,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_BuyerJourneyApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -3978,7 +3908,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4075,7 +4004,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -4096,7 +4024,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4113,8 +4040,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4218,7 +4144,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -4254,7 +4179,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4320,7 +4244,6 @@ "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", "name": "UseBuyerJourneyGeneratedType", "description": "Returns the `buyerJourney` details on buyer progression in checkout.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", @@ -4334,7 +4257,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4431,7 +4353,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -4452,7 +4373,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4469,8 +4389,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4574,7 +4493,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -4610,7 +4528,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4676,7 +4593,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", @@ -4697,7 +4613,6 @@ "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.", - "isPublicDocs": true, "params": [ { "name": "interceptor", @@ -4718,7 +4633,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -4739,7 +4653,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4756,8 +4669,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4861,7 +4773,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -4904,7 +4815,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", @@ -4918,7 +4828,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -4991,7 +4900,6 @@ "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", "name": "UseBuyerJourneyActiveStepGeneratedType", "description": "Returns the buyer journey step that the buyer is currently on.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", @@ -5005,7 +4913,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5164,7 +5071,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_CartInstructionsApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -5218,7 +5124,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5269,7 +5174,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5285,7 +5189,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5301,7 +5204,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5317,7 +5219,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5347,7 +5248,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5370,7 +5270,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5393,7 +5292,6 @@ "filePath": "src/surfaces/checkout/preact/instructions.ts", "name": "UseInstructionsGeneratedType", "description": "Returns the cart instructions used to create the checkout and possibly limit extension capabilities.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/instructions.ts", @@ -5407,7 +5305,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5458,7 +5355,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5474,7 +5370,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5490,7 +5385,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5506,7 +5400,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5536,7 +5429,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5559,7 +5451,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5714,7 +5605,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_CartLinesApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -5768,7 +5658,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5845,7 +5734,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -5892,7 +5780,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5908,7 +5795,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5951,14 +5837,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -5988,7 +5872,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6018,7 +5901,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6048,7 +5930,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6125,7 +6006,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6219,7 +6099,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6243,7 +6122,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6285,7 +6163,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6332,7 +6209,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -6367,7 +6243,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6390,7 +6265,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/cart-lines.ts", @@ -6404,7 +6278,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6481,7 +6354,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -6528,7 +6400,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6544,7 +6415,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6587,14 +6457,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6624,7 +6492,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6654,7 +6521,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6684,7 +6550,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6761,7 +6626,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6855,7 +6719,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6879,7 +6742,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6921,7 +6783,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -6968,7 +6829,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -7003,7 +6863,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7026,7 +6885,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Checkout_CartLinesApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -7043,14 +6901,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -7116,7 +6972,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -7163,7 +7018,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7240,7 +7094,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7256,7 +7109,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7299,14 +7151,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7336,7 +7186,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7366,7 +7215,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7396,7 +7244,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7473,7 +7320,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7567,7 +7413,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7591,7 +7436,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7633,7 +7477,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7680,7 +7523,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -7715,7 +7557,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -7731,7 +7572,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -7773,7 +7613,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -7861,14 +7700,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -7884,7 +7721,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -7914,7 +7750,6 @@ "filePath": "src/surfaces/checkout/preact/cart-lines.ts", "name": "UseApplyCartLinesChangeGeneratedType", "description": "Returns a function to mutate the `lines` property of checkout.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/cart-lines.ts", @@ -7929,14 +7764,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -8002,7 +7835,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -8049,7 +7881,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8126,7 +7957,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8142,7 +7972,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8185,14 +8014,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8222,7 +8049,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8252,7 +8078,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8282,7 +8107,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8359,7 +8183,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8453,7 +8276,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8477,7 +8299,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8519,7 +8340,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8566,7 +8386,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -8601,7 +8420,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8617,7 +8435,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -8659,7 +8476,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -8747,14 +8563,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -8770,7 +8584,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -8800,7 +8613,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_CartLineItem_CartLinesApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -8854,7 +8666,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8931,7 +8742,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -8978,7 +8788,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -8994,7 +8803,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9037,14 +8845,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9074,7 +8880,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9104,7 +8909,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9134,7 +8938,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9211,7 +9014,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9305,7 +9107,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9329,7 +9130,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9371,7 +9171,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9418,7 +9217,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -9453,7 +9251,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9476,7 +9273,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/target.ts", @@ -9490,7 +9286,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9567,7 +9362,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -9614,7 +9408,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9630,7 +9423,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9673,14 +9465,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9710,7 +9500,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9740,7 +9529,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9770,7 +9558,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9847,7 +9634,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9941,7 +9727,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -9965,7 +9750,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10007,7 +9791,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10054,7 +9837,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -10089,7 +9871,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10112,7 +9893,6 @@ "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`", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/cart-line-target.ts", @@ -10126,7 +9906,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10203,7 +9982,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -10250,7 +10028,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10266,7 +10043,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10309,14 +10085,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10346,7 +10120,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10376,7 +10149,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10406,7 +10178,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10483,7 +10254,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10577,7 +10347,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10601,7 +10370,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10643,7 +10411,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10690,7 +10457,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -10725,7 +10491,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -10797,7 +10562,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_CheckoutTokenApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -10852,8 +10616,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" } } }, @@ -10866,7 +10629,6 @@ "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).", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/checkout-token.ts", @@ -10881,8 +10643,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" } } } @@ -10931,7 +10692,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_CostApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -10947,7 +10707,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11022,7 +10781,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11071,7 +10829,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/cost.ts", @@ -11085,7 +10842,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11134,7 +10890,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/cost.ts", @@ -11148,7 +10903,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11197,7 +10951,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/cost.ts", @@ -11211,7 +10964,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11260,7 +11012,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/cost.ts", @@ -11274,7 +11025,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11360,7 +11110,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_CustomerPrivacyApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -11383,7 +11132,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -11404,7 +11152,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11472,7 +11219,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11495,7 +11241,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11537,14 +11282,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11560,7 +11303,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11621,7 +11363,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11697,7 +11438,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11734,7 +11474,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11757,7 +11496,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11820,7 +11558,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/customer-privacy.ts", @@ -11834,7 +11571,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11910,7 +11646,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11947,7 +11682,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -11970,7 +11704,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12026,7 +11759,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12124,7 +11856,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_DeliveryApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -12178,7 +11909,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12232,14 +11962,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12320,7 +12048,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12337,7 +12064,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12379,7 +12105,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12396,7 +12121,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12421,7 +12145,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12482,7 +12205,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12617,7 +12339,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -12853,7 +12574,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12937,14 +12657,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12960,7 +12678,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -12983,7 +12700,6 @@ "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.", - "isPublicDocs": true, "params": [ { "name": "deliveryGroup", @@ -13004,7 +12720,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13058,14 +12773,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13146,7 +12859,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13163,7 +12875,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13205,7 +12916,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13222,7 +12932,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13247,7 +12956,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13308,7 +13016,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13443,7 +13150,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -13679,7 +13385,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13763,14 +13468,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13786,7 +13489,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13802,7 +13504,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroupDetails", "description": "Represents a DeliveryGroup with expanded reference fields and full details.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13855,7 +13556,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13932,7 +13632,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -13979,7 +13678,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -13996,14 +13694,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14033,7 +13729,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14063,7 +13758,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14093,7 +13787,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14170,7 +13863,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14264,7 +13956,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14288,7 +13979,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14330,7 +14020,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14377,7 +14066,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -14412,7 +14100,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14435,7 +14122,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/delivery-groups.ts", @@ -14449,7 +14135,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14503,14 +14188,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14591,7 +14274,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14608,7 +14290,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14650,7 +14331,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14667,7 +14347,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14692,7 +14371,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14753,7 +14431,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -14888,7 +14565,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -15124,7 +14800,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15208,14 +14883,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15231,7 +14904,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15254,7 +14926,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", "name": "ShippingOptionItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -15322,7 +14993,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", "name": "ShippingOptionItemRenderMode", "description": "The render mode of a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -15338,7 +15008,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15419,7 +15088,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15436,7 +15104,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15478,7 +15145,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15495,7 +15161,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15520,7 +15185,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15588,7 +15252,6 @@ "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`", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/shipping-option-target.ts", @@ -15602,7 +15265,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15683,7 +15345,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15700,7 +15361,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15742,7 +15402,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15759,7 +15418,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15784,7 +15442,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15845,7 +15502,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", "name": "ShippingOptionItemRenderMode", "description": "The render mode of a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -15868,7 +15524,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "ShippingOptionListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -15929,7 +15584,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "DeliverySelectionGroup", "description": "A named group of delivery options that the buyer can select as a unit.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -15980,7 +15634,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -15996,7 +15649,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16038,7 +15690,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "DeliveryGroupList", "description": "A collection of delivery groups that share the same group type.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -16061,7 +15712,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16115,14 +15765,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16203,7 +15851,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16220,7 +15867,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16237,7 +15883,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16262,7 +15907,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16323,7 +15967,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16458,7 +16101,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -16694,7 +16336,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16778,14 +16419,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "CartLineReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16808,7 +16447,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/delivery-group-target.ts", @@ -16822,7 +16460,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16876,14 +16513,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16964,7 +16599,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -16981,7 +16615,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17023,7 +16656,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17040,7 +16672,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17065,7 +16696,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17126,7 +16756,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17261,7 +16890,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -17497,7 +17125,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17581,14 +17208,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17604,7 +17229,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17627,7 +17251,6 @@ "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", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/delivery-group-list-target.ts", @@ -17641,7 +17264,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "DeliveryGroupList", "description": "A collection of delivery groups that share the same group type.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -17664,7 +17286,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17718,14 +17339,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17806,7 +17425,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17823,7 +17441,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17865,7 +17482,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17882,7 +17498,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17907,7 +17522,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -17968,7 +17582,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -18103,7 +17716,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -18339,7 +17951,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -18423,14 +18034,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -18446,7 +18055,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -18469,7 +18077,6 @@ "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", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/delivery-selection-groups.ts", @@ -18483,7 +18090,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "DeliverySelectionGroup", "description": "A named group of delivery options that the buyer can select as a unit.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -18534,7 +18140,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -18550,7 +18155,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -18599,7 +18203,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", "name": "PickupPointListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", @@ -18660,7 +18263,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", "name": "PickupLocationListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", @@ -18721,7 +18323,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", "name": "PickupLocationItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", @@ -18782,7 +18383,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -18865,7 +18465,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -19101,7 +18700,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -19169,7 +18767,6 @@ "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`", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/pickup-location-option-target.ts", @@ -19183,7 +18780,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -19266,7 +18862,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -19502,7 +19097,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -19676,7 +19270,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_DiscountsApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -19738,14 +19331,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -19775,7 +19366,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -19817,7 +19407,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -19847,7 +19436,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -19877,7 +19465,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -19900,7 +19487,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Checkout_DiscountsApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -19917,14 +19503,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -19947,7 +19531,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -19971,14 +19554,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -19994,7 +19575,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -20024,7 +19604,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/discounts.ts", @@ -20039,14 +19618,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -20069,7 +19646,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -20093,14 +19669,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -20116,7 +19690,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -20146,7 +19719,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/discounts.ts", @@ -20161,14 +19733,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20198,7 +19768,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20240,7 +19809,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20270,7 +19838,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20307,7 +19874,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/discounts.ts", @@ -20321,7 +19887,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20380,14 +19945,13 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_ExtensionMetaApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." } ], "value": "export interface Docs_Standard_ExtensionMetaApi\n extends Pick {}" @@ -20395,8 +19959,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20543,8 +20106,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20567,7 +20129,6 @@ "filePath": "src/surfaces/checkout/preact/extension.ts", "name": "UseExtensionGeneratedType", "description": "Returns the metadata about the extension.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/extension.ts", @@ -20580,8 +20141,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20728,8 +20288,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20752,7 +20311,6 @@ "filePath": "src/surfaces/checkout/preact/extension.ts", "name": "UseExtensionDataGeneratedType", "description": "Returns the metadata about the extension. > Caution: This is deprecated, use `useExtension()` instead.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/extension.ts", @@ -20765,8 +20323,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20913,8 +20470,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -20937,7 +20493,6 @@ "filePath": "src/surfaces/checkout/preact/capabilities.ts", "name": "UseExtensionCapabilitiesGeneratedType", "description": "Returns a list of an extension's granted capabilities.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/capabilities.ts", @@ -20965,7 +20520,6 @@ "filePath": "src/surfaces/checkout/preact/capabilities.ts", "name": "UseExtensionCapabilityGeneratedType", "description": "Returns whether or not a given capability of an extension is granted.", - "isPublicDocs": true, "params": [ { "name": "capability", @@ -21000,7 +20554,6 @@ "filePath": "src/surfaces/checkout/preact/extension-editor.ts", "name": "UseExtensionEditorGeneratedType", "description": "Returns information about the editor where the extension is being rendered.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/extension-editor.ts", @@ -21013,8 +20566,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21073,7 +20625,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_GiftCardsApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -21127,7 +20678,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21157,7 +20707,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21206,7 +20755,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Checkout_GiftCardsApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -21223,14 +20771,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -21253,7 +20799,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -21277,14 +20822,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -21300,7 +20843,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -21330,7 +20872,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/gift-cards.ts", @@ -21344,7 +20885,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21374,7 +20914,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21423,7 +20962,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/gift-cards.ts", @@ -21438,14 +20976,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -21468,7 +21004,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -21492,14 +21027,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -21515,7 +21048,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -21581,21 +21113,20 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_LocalizationApi", "description": "", - "isPublicDocs": true, "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/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." } ], "value": "export interface Docs_Standard_LocalizationApi\n extends Pick {}" @@ -21603,8 +21134,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21640,16 +21170,14 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "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": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21692,10 +21220,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -21783,7 +21311,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21806,7 +21333,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21822,7 +21348,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21859,7 +21384,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/currency.ts", @@ -21873,7 +21397,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21903,7 +21426,6 @@ "filePath": "src/surfaces/checkout/preact/extension-language.ts", "name": "UseExtensionLanguageGeneratedType", "description": "Returns the buyer's language, as supported by the extension.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/extension-language.ts", @@ -21917,7 +21439,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21940,7 +21461,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/language.ts", @@ -21954,7 +21474,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -21977,7 +21496,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/country.ts", @@ -22042,7 +21560,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/market.ts", @@ -22056,7 +21573,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -22086,7 +21602,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/timezone.ts", @@ -22107,7 +21622,6 @@ "filePath": "src/surfaces/checkout/preact/translate.ts", "name": "UseTranslateGeneratedType", "description": "Returns the `I18nTranslate` interface used to translate strings.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/translate.ts", @@ -22120,8 +21634,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" } @@ -22214,7 +21727,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_LocalizedFieldsApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -22269,7 +21781,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -22325,7 +21836,6 @@ "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.", - "isPublicDocs": true, "params": [ { "name": "keys", @@ -22354,7 +21864,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -22403,7 +21912,6 @@ "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.", - "isPublicDocs": true, "params": [ { "name": "key", @@ -22431,7 +21939,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -22530,7 +22037,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_MetafieldsApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -22584,7 +22090,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -22607,7 +22112,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -22651,7 +22155,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -22693,7 +22196,6 @@ "filePath": "src/surfaces/checkout/preact/app-metafields.ts", "name": "UseAppMetafieldsGeneratedType", "description": "Returns the metafields configured with `shopify.extension.toml`.", - "isPublicDocs": true, "params": [ { "name": "filters", @@ -22756,7 +22258,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -22779,7 +22280,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -22823,7 +22323,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -22865,7 +22364,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Checkout_MetafieldsApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -22882,14 +22380,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -22920,7 +22416,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -22957,7 +22452,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -22981,14 +22475,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23004,7 +22496,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23034,7 +22525,6 @@ "filePath": "src/surfaces/checkout/preact/metafields.ts", "name": "UseApplyMetafieldsChangeGeneratedType", "description": "Returns a function to mutate the `metafields` property of the checkout.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/metafields.ts", @@ -23049,14 +22539,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23087,7 +22575,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -23124,7 +22611,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23148,14 +22634,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23171,7 +22655,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23255,7 +22738,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_NoteApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -23316,7 +22798,6 @@ "filePath": "src/surfaces/checkout/preact/note.ts", "name": "UseNoteGeneratedType", "description": "Returns the proposed `note` applied to the checkout.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/note.ts", @@ -23337,7 +22818,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Checkout_NoteApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -23354,14 +22834,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23377,7 +22855,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23401,14 +22878,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23424,7 +22899,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23454,7 +22928,6 @@ "filePath": "src/surfaces/checkout/preact/note.ts", "name": "UseApplyNoteChangeGeneratedType", "description": "Returns a function to mutate the `note` property of the checkout.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/note.ts", @@ -23469,14 +22942,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23492,7 +22963,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23516,14 +22986,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23539,7 +23007,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -23618,7 +23085,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmationApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -23672,7 +23138,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -23760,7 +23225,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_PaymentOptionsApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -23821,7 +23285,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -23846,7 +23309,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -23875,7 +23337,6 @@ "filePath": "src/surfaces/checkout/preact/payment-options.ts", "name": "UseAvailablePaymentOptionsGeneratedType", "description": "Returns all available payment options.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/payment-options.ts", @@ -23889,7 +23350,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -23919,7 +23379,6 @@ "filePath": "src/surfaces/checkout/preact/payment-options.ts", "name": "UseSelectedPaymentOptionsGeneratedType", "description": "Returns payment options selected by the buyer.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/payment-options.ts", @@ -23935,7 +23394,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24031,7 +23489,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_QueryApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -24150,7 +23607,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_SessionTokenApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -24165,8 +23621,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24189,7 +23644,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/session-token.ts", @@ -24202,8 +23656,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24293,7 +23746,6 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_SettingsApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", @@ -24349,7 +23801,6 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] } } @@ -24363,7 +23814,6 @@ "filePath": "src/surfaces/checkout/preact/settings.ts", "name": "UseSettingsGeneratedType", "description": "Returns the setting values defined by the merchant for the extension.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/settings.ts", @@ -24379,7 +23829,6 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] } } @@ -24460,14 +23909,13 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_ShopApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/docs.ts", "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." } ], "value": "export interface Docs_Standard_ShopApi extends Pick {}" @@ -24475,8 +23923,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24516,11 +23963,11 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" } } }, @@ -24533,7 +23980,6 @@ "filePath": "src/surfaces/checkout/preact/shop.ts", "name": "UseShopGeneratedType", "description": "Returns the `Shop` where the checkout is taking place.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/shop.ts", @@ -24546,8 +23992,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24587,11 +24032,11 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" } } } @@ -24640,14 +24085,13 @@ "filePath": "src/surfaces/checkout/api/docs.ts", "name": "Docs_Standard_StorageApi", "description": "", - "isPublicDocs": true, "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." } ], "value": "export interface Docs_Standard_StorageApi\n extends Pick {}" @@ -24655,22 +24099,21 @@ "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24680,7 +24123,7 @@ "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}" + "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 type.\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 * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" } } }, @@ -24693,7 +24136,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/storage.ts", @@ -24706,22 +24148,21 @@ "Storage": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Storage", - "description": "A key-value storage object for the extension.\n\nStored data is available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -24731,7 +24172,7 @@ "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}" + "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 type.\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 * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" } } } @@ -24792,7 +24233,6 @@ "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.", - "isPublicDocs": true, "params": [ { "name": "_target", @@ -24814,7 +24254,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/extension-targets.ts", @@ -25343,7 +24782,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -25413,14 +24851,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -25450,7 +24886,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -25497,7 +24932,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -25521,14 +24955,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -25544,7 +24976,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -25568,14 +24999,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -25641,7 +25070,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -25718,7 +25146,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -25734,7 +25161,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -25777,14 +25203,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -25814,7 +25238,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -25844,7 +25267,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -25874,7 +25296,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -25951,7 +25372,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -26045,7 +25465,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -26069,7 +25488,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -26111,7 +25529,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -26158,7 +25575,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -26193,7 +25609,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -26209,7 +25624,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26251,7 +25665,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26339,14 +25752,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26362,7 +25773,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26386,14 +25796,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26416,7 +25824,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26440,14 +25847,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26463,7 +25868,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26487,14 +25891,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26517,7 +25919,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26541,14 +25942,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26564,7 +25963,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26588,14 +25986,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26626,7 +26022,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -26663,7 +26058,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26687,14 +26081,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26710,7 +26102,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26734,14 +26125,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26757,7 +26146,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26781,14 +26169,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26804,7 +26190,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26827,7 +26212,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -26850,7 +26234,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -27095,14 +26478,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -27125,7 +26506,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -27148,7 +26528,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -27172,7 +26551,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -27401,14 +26779,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27522,7 +26899,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27549,7 +26926,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27570,7 +26947,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27628,14 +27005,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27657,44 +27034,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27710,7 +27084,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27724,10 +27097,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -27771,7 +27144,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27801,7 +27173,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -27822,7 +27193,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27890,7 +27260,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27913,7 +27282,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27955,14 +27323,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -27978,7 +27344,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28001,7 +27366,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28024,7 +27388,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28068,7 +27431,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28103,7 +27465,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28126,7 +27487,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28163,7 +27523,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28275,7 +27634,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28310,7 +27668,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28333,7 +27690,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28376,7 +27732,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28419,7 +27774,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28478,7 +27832,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -28499,7 +27852,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28516,8 +27868,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28621,7 +27972,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -28657,7 +28007,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28716,7 +28065,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28747,7 +28095,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28798,7 +28145,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28815,14 +28161,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28859,7 +28203,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28935,7 +28278,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28972,7 +28314,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -28995,7 +28336,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29044,7 +28384,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29098,14 +28437,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29186,7 +28523,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29203,7 +28539,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29220,7 +28555,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29245,7 +28579,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29306,7 +28639,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29441,7 +28773,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29525,14 +28856,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29548,7 +28877,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29564,7 +28892,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29579,8 +28906,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29689,8 +29015,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29705,8 +29030,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29742,8 +29066,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -29751,7 +29074,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29802,7 +29124,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29818,7 +29139,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29834,7 +29154,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29850,7 +29169,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29880,7 +29198,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29903,7 +29220,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29918,8 +29234,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -29962,10 +29277,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -30008,7 +29323,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30024,7 +29338,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30040,7 +29353,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30070,7 +29382,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30150,7 +29461,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30171,8 +29481,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30190,14 +29499,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30237,31 +29544,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -30271,15 +29577,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" }, "AnyCheckoutComponent": { "filePath": "src/surfaces/checkout/shared.ts", @@ -30292,7 +29597,6 @@ "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", "name": "CartLineItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", @@ -30308,7 +29612,6 @@ "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", "name": "RedeemableApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", @@ -30324,7 +29627,6 @@ "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", "name": "RedeemableAddChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", @@ -30354,7 +29656,6 @@ "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", "name": "RedeemableAttribute", "description": "A key-value pair that represents an attribute of a redeemable payment method.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", @@ -30378,14 +29679,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "RedeemableChangeResult", "value": "RedeemableChangeResultSuccess | RedeemableChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "RedeemableChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", "name": "RedeemableChangeResultSuccess", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", @@ -30401,7 +29700,6 @@ "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", "name": "RedeemableChangeResultError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", @@ -30431,7 +29729,6 @@ "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", "name": "PaymentOptionItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", @@ -30463,7 +29760,6 @@ "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", "name": "PaymentMethodAttributesUpdateChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", @@ -30486,7 +29782,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", @@ -30510,14 +29805,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "PaymentMethodAttributesResult", "value": "PaymentMethodAttributesResultSuccess | PaymentMethodAttributesResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "PaymentMethodAttributesResultSuccess": { "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", "name": "PaymentMethodAttributesResultSuccess", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", @@ -30533,7 +29826,6 @@ "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", "name": "PaymentMethodAttributesResultError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", @@ -30556,7 +29848,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", "name": "PickupLocationListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", @@ -30572,7 +29863,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", "name": "PickupPointListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", @@ -30588,7 +29878,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", "name": "ShippingOptionItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -30618,7 +29907,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", "name": "ShippingOptionItemRenderMode", "description": "The render mode of a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -30634,7 +29922,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "ShippingOptionListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -30657,7 +29944,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "DeliverySelectionGroup", "description": "A named group of delivery options that the buyer can select as a unit.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -30708,7 +29994,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "DeliveryGroupList", "description": "A collection of delivery groups that share the same group type.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -30731,7 +30016,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmationApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -30747,7 +30031,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -30785,7 +30068,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", "name": "PickupLocationItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", @@ -30815,7 +30097,6 @@ "filePath": "src/surfaces/checkout/api/announcement/announcement.ts", "name": "Announcement", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/announcement/announcement.ts", @@ -30832,16 +30113,14 @@ "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.", - "isPublicDocs": true + "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.", - "isPublicDocs": true + "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." } } } @@ -30902,7 +30181,6 @@ "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.", - "isPublicDocs": true, "params": [], "returns": { "filePath": "src/surfaces/checkout/preact/api.ts", @@ -30917,22 +30195,19 @@ "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.", - "isPublicDocs": true + "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.", - "isPublicDocs": true + "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/extension-targets.ts", @@ -31461,7 +30736,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -31531,14 +30805,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -31568,7 +30840,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -31615,7 +30886,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -31639,14 +30909,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -31662,7 +30930,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -31686,14 +30953,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -31759,7 +31024,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -31836,7 +31100,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -31852,7 +31115,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -31895,14 +31157,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -31932,7 +31192,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -31962,7 +31221,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -31992,7 +31250,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -32069,7 +31326,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -32163,7 +31419,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -32187,7 +31442,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -32229,7 +31483,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -32276,7 +31529,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -32311,7 +31563,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -32327,7 +31578,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32369,7 +31619,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32457,14 +31706,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32480,7 +31727,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32504,14 +31750,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32534,7 +31778,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32558,14 +31801,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32581,7 +31822,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32605,14 +31845,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32635,7 +31873,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32659,14 +31896,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32682,7 +31917,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32706,14 +31940,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32744,7 +31976,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -32781,7 +32012,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32805,14 +32035,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32828,7 +32056,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32852,14 +32079,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32875,7 +32100,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32899,14 +32123,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32922,7 +32144,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32945,7 +32166,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -32968,7 +32188,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -33213,14 +32432,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -33243,7 +32460,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -33266,7 +32482,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -33290,7 +32505,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -33519,14 +32733,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33640,7 +32853,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33667,7 +32880,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33688,7 +32901,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33746,14 +32959,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33775,44 +32988,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33828,7 +33038,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33842,10 +33051,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -33889,7 +33098,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -33919,7 +33127,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -33940,7 +33147,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34008,7 +33214,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34031,7 +33236,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34073,14 +33277,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34096,7 +33298,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34119,7 +33320,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34142,7 +33342,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34186,7 +33385,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34221,7 +33419,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34244,7 +33441,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34281,7 +33477,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34393,7 +33588,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34428,7 +33622,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34451,7 +33644,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34494,7 +33686,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34537,7 +33728,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34596,7 +33786,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -34617,7 +33806,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34634,8 +33822,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34739,7 +33926,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -34775,7 +33961,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34834,7 +34019,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34865,7 +34049,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34916,7 +34099,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34933,14 +34115,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -34977,7 +34157,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35053,7 +34232,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35090,7 +34268,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35113,7 +34290,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35162,7 +34338,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35216,14 +34391,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35304,7 +34477,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35321,7 +34493,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35338,7 +34509,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35363,7 +34533,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35424,7 +34593,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35559,7 +34727,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35643,14 +34810,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35666,7 +34831,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35682,7 +34846,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35697,8 +34860,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35807,8 +34969,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35823,8 +34984,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35860,8 +35020,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -35869,7 +35028,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35920,7 +35078,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35936,7 +35093,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35952,7 +35108,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35968,7 +35123,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -35998,7 +35152,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36021,7 +35174,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36036,8 +35188,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36080,10 +35231,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -36126,7 +35277,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36142,7 +35292,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36158,7 +35307,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36188,7 +35336,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36268,7 +35415,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36289,8 +35435,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36308,14 +35453,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36355,31 +35498,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -36389,15 +35531,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" }, "AnyCheckoutComponent": { "filePath": "src/surfaces/checkout/shared.ts", @@ -36410,7 +35551,6 @@ "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", "name": "CartLineItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", @@ -36426,7 +35566,6 @@ "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", "name": "RedeemableApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", @@ -36442,7 +35581,6 @@ "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", "name": "RedeemableAddChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", @@ -36472,7 +35610,6 @@ "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", "name": "RedeemableAttribute", "description": "A key-value pair that represents an attribute of a redeemable payment method.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", @@ -36496,14 +35633,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "RedeemableChangeResult", "value": "RedeemableChangeResultSuccess | RedeemableChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "RedeemableChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", "name": "RedeemableChangeResultSuccess", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", @@ -36519,7 +35654,6 @@ "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", "name": "RedeemableChangeResultError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", @@ -36549,7 +35683,6 @@ "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", "name": "PaymentOptionItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", @@ -36581,7 +35714,6 @@ "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", "name": "PaymentMethodAttributesUpdateChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", @@ -36604,7 +35736,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", @@ -36628,14 +35759,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "PaymentMethodAttributesResult", "value": "PaymentMethodAttributesResultSuccess | PaymentMethodAttributesResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "PaymentMethodAttributesResultSuccess": { "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", "name": "PaymentMethodAttributesResultSuccess", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", @@ -36651,7 +35780,6 @@ "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", "name": "PaymentMethodAttributesResultError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", @@ -36674,7 +35802,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", "name": "PickupLocationListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", @@ -36690,7 +35817,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", "name": "PickupPointListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", @@ -36706,7 +35832,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", "name": "ShippingOptionItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -36736,7 +35861,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", "name": "ShippingOptionItemRenderMode", "description": "The render mode of a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -36752,7 +35876,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "ShippingOptionListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -36775,7 +35898,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "DeliverySelectionGroup", "description": "A named group of delivery options that the buyer can select as a unit.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -36826,7 +35948,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "DeliveryGroupList", "description": "A collection of delivery groups that share the same group type.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -36849,7 +35970,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmationApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -36865,7 +35985,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -36903,7 +36022,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", "name": "PickupLocationItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", @@ -36933,7 +36051,6 @@ "filePath": "src/surfaces/checkout/api/announcement/announcement.ts", "name": "Announcement", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/announcement/announcement.ts", @@ -37004,7 +36121,6 @@ "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.", - "isPublicDocs": true, "params": [ { "name": "subscription", @@ -37149,7 +36265,6 @@ "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", "name": "AddressAutocompleteFormatSuggestionApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", @@ -37180,7 +36295,6 @@ "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", "name": "AddressAutocompleteSuggestion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", @@ -37256,7 +36370,6 @@ "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", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", @@ -37452,7 +36565,6 @@ "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", "name": "MatchedSubstring", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", @@ -37482,7 +36594,6 @@ "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", "name": "AddressAutocompleteFormatSuggestionOutput", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", @@ -37498,7 +36609,6 @@ "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", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", @@ -37701,7 +36811,6 @@ "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", "name": "AddressAutocompleteStandardApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -37828,39 +36937,36 @@ "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -37876,7 +36982,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -37890,16 +36995,15 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "AppMetafieldEntry": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -37922,7 +37026,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -37966,7 +37069,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38001,7 +37103,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -38048,7 +37149,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -38285,8 +37385,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "Extension": { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -38400,8 +37499,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38416,8 +37514,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38453,8 +37550,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -38549,7 +37645,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38572,7 +37667,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38588,7 +37682,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38646,8 +37739,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38665,14 +37757,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38712,31 +37802,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -38746,15 +37835,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -38811,7 +37899,6 @@ "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", "name": "AddressAutocompleteSuggestApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", @@ -38914,7 +38001,6 @@ "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", "name": "AddressAutocompleteSuggestOutput", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", @@ -38930,7 +38016,6 @@ "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", "name": "AddressAutocompleteSuggestion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", @@ -39006,7 +38091,6 @@ "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", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", @@ -39202,7 +38286,6 @@ "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", "name": "MatchedSubstring", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", @@ -39232,7 +38315,6 @@ "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", "name": "AddressAutocompleteStandardApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -39359,39 +38441,36 @@ "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -39407,7 +38486,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -39421,16 +38499,15 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "AppMetafieldEntry": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -39453,7 +38530,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -39497,7 +38573,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -39532,7 +38607,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -39579,7 +38653,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -39816,8 +38889,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "Extension": { "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", @@ -39931,8 +39003,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -39947,8 +39018,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -39984,8 +39054,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -40080,7 +39149,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40103,7 +39171,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40119,7 +39186,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40177,8 +39243,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40196,14 +39261,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40243,31 +39306,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40277,15 +39339,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -40348,7 +39409,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -40418,14 +39478,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -40455,7 +39513,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -40502,7 +39559,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -40526,14 +39582,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -40549,7 +39603,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -40573,14 +39626,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -40646,7 +39697,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40723,7 +39773,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40739,7 +39788,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40782,14 +39830,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40819,7 +39865,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40849,7 +39894,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40879,7 +39923,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -40956,7 +39999,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -41050,7 +40092,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -41074,7 +40115,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -41116,7 +40156,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -41163,7 +40202,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -41198,7 +40236,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -41214,7 +40251,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41256,7 +40292,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41344,14 +40379,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41367,7 +40400,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41391,14 +40423,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41421,7 +40451,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41445,14 +40474,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41468,7 +40495,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41492,14 +40518,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41522,7 +40546,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41546,14 +40569,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41569,7 +40590,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41593,14 +40613,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41631,7 +40649,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -41668,7 +40685,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41692,14 +40708,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41715,7 +40729,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41739,14 +40752,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41762,7 +40773,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41786,14 +40796,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41809,7 +40817,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41832,7 +40839,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -41855,7 +40861,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -42100,14 +41105,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -42130,7 +41133,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -42153,7 +41155,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -42177,7 +41178,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -42413,14 +41413,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42534,7 +41533,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42561,7 +41560,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42582,7 +41581,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42640,14 +41639,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42669,44 +41668,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42722,7 +41718,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42736,10 +41731,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -42783,7 +41778,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42813,7 +41807,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42855,7 +41848,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -42876,7 +41868,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42944,7 +41935,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -42967,7 +41957,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43009,14 +41998,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43032,7 +42019,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43055,7 +42041,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43078,7 +42063,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43122,7 +42106,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43157,7 +42140,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -43204,7 +42186,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43227,7 +42208,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -43463,7 +42443,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43500,7 +42479,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43612,7 +42590,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43636,7 +42613,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43671,7 +42647,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43694,7 +42669,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43737,7 +42711,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43780,7 +42753,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43839,7 +42811,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -43860,7 +42831,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43877,8 +42847,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -43982,7 +42951,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -44018,7 +42986,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44077,7 +43044,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44108,7 +43074,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44159,7 +43124,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44176,14 +43140,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44220,7 +43182,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44296,7 +43257,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44333,7 +43293,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44356,7 +43315,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44405,7 +43363,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44459,14 +43416,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44547,7 +43502,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44564,7 +43518,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44581,7 +43534,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44606,7 +43558,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44667,7 +43618,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44802,7 +43752,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44886,14 +43835,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44909,7 +43856,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44926,14 +43872,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44963,7 +43907,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -44993,7 +43936,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45023,7 +43965,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45038,8 +43979,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45148,8 +44088,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45164,8 +44103,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45201,8 +44139,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -45210,7 +44147,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45261,7 +44197,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45277,7 +44212,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45293,7 +44227,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45309,7 +44242,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45339,7 +44271,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45362,7 +44293,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45378,7 +44308,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45455,7 +44384,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45471,7 +44399,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45548,7 +44475,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45642,7 +44568,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45684,7 +44609,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45731,7 +44655,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -45766,7 +44689,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45781,8 +44703,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45825,10 +44746,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -45871,7 +44792,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45887,7 +44807,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45903,7 +44822,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -45933,7 +44851,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46013,7 +44930,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46034,8 +44950,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46053,14 +44968,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -46296,8 +45209,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46337,31 +45249,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46371,15 +45282,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -46442,7 +45352,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -46512,14 +45421,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -46549,7 +45456,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -46596,7 +45502,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -46620,14 +45525,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -46643,7 +45546,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -46667,14 +45569,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -46740,7 +45640,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46817,7 +45716,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46833,7 +45731,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46876,14 +45773,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46913,7 +45808,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46943,7 +45837,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -46973,7 +45866,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -47050,7 +45942,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -47144,7 +46035,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -47168,7 +46058,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -47210,7 +46099,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -47257,7 +46145,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -47292,7 +46179,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -47308,7 +46194,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47350,7 +46235,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47438,14 +46322,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47461,7 +46343,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47485,14 +46366,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47515,7 +46394,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47539,14 +46417,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47562,7 +46438,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47586,14 +46461,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47616,7 +46489,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47640,14 +46512,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47663,7 +46533,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47687,14 +46556,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47725,7 +46592,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -47762,7 +46628,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47786,14 +46651,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47809,7 +46672,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47833,14 +46695,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47856,7 +46716,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47880,14 +46739,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47903,7 +46760,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47926,7 +46782,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -47949,7 +46804,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -48194,14 +47048,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -48224,7 +47076,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -48247,7 +47098,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -48271,7 +47121,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -48507,14 +47356,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48628,7 +47476,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48655,7 +47503,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48676,7 +47524,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48734,14 +47582,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48763,44 +47611,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48816,7 +47661,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48830,10 +47674,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -48877,7 +47721,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48907,7 +47750,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -48949,7 +47791,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -48970,7 +47811,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49038,7 +47878,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49061,7 +47900,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49103,14 +47941,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49126,7 +47962,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49149,7 +47984,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49172,7 +48006,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49216,7 +48049,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49251,7 +48083,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -49298,7 +48129,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49321,7 +48151,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -49557,7 +48386,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49594,7 +48422,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49706,7 +48533,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49730,7 +48556,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49765,7 +48590,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49788,7 +48612,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49831,7 +48654,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49874,7 +48696,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49933,7 +48754,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -49954,7 +48774,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -49971,8 +48790,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50076,7 +48894,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -50112,7 +48929,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50171,7 +48987,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50202,7 +49017,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50253,7 +49067,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50270,14 +49083,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50314,7 +49125,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50390,7 +49200,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50427,7 +49236,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50450,7 +49258,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50499,7 +49306,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50553,14 +49359,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50641,7 +49445,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50658,7 +49461,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50675,7 +49477,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50700,7 +49501,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50761,7 +49561,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50896,7 +49695,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -50980,14 +49778,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51003,7 +49799,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51020,14 +49815,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51057,7 +49850,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51087,7 +49879,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51117,7 +49908,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51132,8 +49922,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51242,8 +50031,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51258,8 +50046,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51295,8 +50082,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -51304,7 +50090,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51355,7 +50140,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51371,7 +50155,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51387,7 +50170,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51403,7 +50185,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51433,7 +50214,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51456,7 +50236,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51472,7 +50251,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51549,7 +50327,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51565,7 +50342,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51642,7 +50418,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51736,7 +50511,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51778,7 +50552,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51825,7 +50598,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -51860,7 +50632,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51875,8 +50646,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51919,10 +50689,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -51965,7 +50735,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51981,7 +50750,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -51997,7 +50765,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52027,7 +50794,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52107,7 +50873,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52128,8 +50893,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52147,14 +50911,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -52390,8 +51152,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52431,31 +51192,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52465,15 +51225,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -52536,7 +51295,6 @@ "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", "name": "CartLineItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", @@ -52590,7 +51348,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52667,7 +51424,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -52714,7 +51470,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52730,7 +51485,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52773,14 +51527,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52810,7 +51562,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52840,7 +51591,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52870,7 +51620,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -52947,7 +51696,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53041,7 +51789,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53065,7 +51812,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53107,7 +51853,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53154,7 +51899,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -53189,7 +51933,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53212,7 +51955,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -53282,14 +52024,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -53319,7 +52059,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -53366,7 +52105,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -53390,14 +52128,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -53413,7 +52149,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -53437,14 +52172,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -53510,7 +52243,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53587,7 +52319,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53603,7 +52334,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53646,14 +52376,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53683,7 +52411,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53713,7 +52440,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53743,7 +52469,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53820,7 +52545,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53914,7 +52638,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53938,7 +52661,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -53980,7 +52702,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -54027,7 +52748,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -54062,7 +52782,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -54078,7 +52797,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54120,7 +52838,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54208,14 +52925,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54231,7 +52946,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54255,14 +52969,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54285,7 +52997,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54309,14 +53020,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54332,7 +53041,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54356,14 +53064,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54386,7 +53092,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54410,14 +53115,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54433,7 +53136,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54457,14 +53159,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54495,7 +53195,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -54532,7 +53231,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54556,14 +53254,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54579,7 +53275,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54603,14 +53298,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54626,7 +53319,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54650,14 +53342,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54673,7 +53363,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54696,7 +53385,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54719,7 +53407,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -54964,14 +53651,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -54994,7 +53679,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -55017,7 +53701,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -55041,7 +53724,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -55277,14 +53959,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55398,7 +54079,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55425,7 +54106,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55446,7 +54127,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55504,14 +54185,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55533,44 +54214,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55586,7 +54264,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55600,10 +54277,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -55647,7 +54324,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55677,7 +54353,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55719,7 +54394,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -55740,7 +54414,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55808,7 +54481,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55831,7 +54503,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55873,14 +54544,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55896,7 +54565,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55919,7 +54587,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55942,7 +54609,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -55986,7 +54652,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56021,7 +54686,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -56068,7 +54732,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56091,7 +54754,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -56327,7 +54989,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56364,7 +55025,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56476,7 +55136,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56500,7 +55159,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56535,7 +55193,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56558,7 +55215,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56601,7 +55257,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56644,7 +55299,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56703,7 +55357,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -56724,7 +55377,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56741,8 +55393,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56846,7 +55497,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -56882,7 +55532,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56941,7 +55590,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -56972,7 +55620,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57023,7 +55670,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57040,14 +55686,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57084,7 +55728,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57160,7 +55803,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57197,7 +55839,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57220,7 +55861,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57269,7 +55909,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57323,14 +55962,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57411,7 +56048,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57428,7 +56064,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57445,7 +56080,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57470,7 +56104,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57531,7 +56164,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57666,7 +56298,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57750,14 +56381,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57773,7 +56402,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57790,14 +56418,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57827,7 +56453,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57857,7 +56482,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57887,7 +56511,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -57902,8 +56525,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58012,8 +56634,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58028,8 +56649,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58065,8 +56685,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -58074,7 +56693,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58125,7 +56743,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58141,7 +56758,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58157,7 +56773,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58173,7 +56788,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58203,7 +56817,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58226,7 +56839,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58242,7 +56854,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58319,7 +56930,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58335,7 +56945,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58412,7 +57021,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58506,7 +57114,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58548,7 +57155,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58595,7 +57201,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -58630,7 +57235,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58645,8 +57249,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58689,10 +57292,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -58735,7 +57338,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58751,7 +57353,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58767,7 +57368,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58797,7 +57397,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58877,7 +57476,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58898,8 +57496,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -58917,14 +57514,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -59160,8 +57755,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59201,31 +57795,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59235,15 +57828,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -59306,7 +57898,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -59376,14 +57967,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -59413,7 +58002,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -59460,7 +58048,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -59484,14 +58071,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -59507,7 +58092,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -59531,14 +58115,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -59604,7 +58186,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59681,7 +58262,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59697,7 +58277,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59740,14 +58319,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59777,7 +58354,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59807,7 +58383,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59837,7 +58412,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -59914,7 +58488,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -60008,7 +58581,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -60032,7 +58604,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -60074,7 +58645,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -60121,7 +58691,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -60156,7 +58725,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -60172,7 +58740,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60214,7 +58781,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60302,14 +58868,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60325,7 +58889,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60349,14 +58912,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60379,7 +58940,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60403,14 +58963,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60426,7 +58984,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60450,14 +59007,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60480,7 +59035,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60504,14 +59058,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60527,7 +59079,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60551,14 +59102,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60589,7 +59138,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -60626,7 +59174,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60650,14 +59197,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60673,7 +59218,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60697,14 +59241,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60720,7 +59262,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60744,14 +59285,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60767,7 +59306,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60790,7 +59328,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -60813,7 +59350,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -61058,14 +59594,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -61088,7 +59622,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -61111,7 +59644,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -61135,7 +59667,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -61371,14 +59902,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61492,7 +60022,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61519,7 +60049,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61540,7 +60070,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61598,14 +60128,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61627,44 +60157,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61680,7 +60207,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61694,10 +60220,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -61741,7 +60267,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61771,7 +60296,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61813,7 +60337,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -61834,7 +60357,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61902,7 +60424,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61925,7 +60446,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61967,14 +60487,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -61990,7 +60508,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62013,7 +60530,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62036,7 +60552,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62080,7 +60595,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62115,7 +60629,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -62162,7 +60675,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62185,7 +60697,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -62421,7 +60932,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62458,7 +60968,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62570,7 +61079,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62594,7 +61102,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62629,7 +61136,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62652,7 +61158,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62695,7 +61200,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62738,7 +61242,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62797,7 +61300,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -62818,7 +61320,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62835,8 +61336,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -62940,7 +61440,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -62976,7 +61475,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63035,7 +61533,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63066,7 +61563,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63117,7 +61613,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63134,14 +61629,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63178,7 +61671,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63254,7 +61746,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63291,7 +61782,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63314,7 +61804,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63363,7 +61852,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63417,14 +61905,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63505,7 +61991,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63522,7 +62007,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63539,7 +62023,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63564,7 +62047,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63625,7 +62107,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63760,7 +62241,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63844,14 +62324,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63867,7 +62345,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63884,14 +62361,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63921,7 +62396,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63951,7 +62425,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63981,7 +62454,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -63996,8 +62468,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64106,8 +62577,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64122,8 +62592,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64159,8 +62628,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -64168,7 +62636,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64219,7 +62686,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64235,7 +62701,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64251,7 +62716,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64267,7 +62731,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64297,7 +62760,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64320,7 +62782,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64336,7 +62797,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64413,7 +62873,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64429,7 +62888,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64506,7 +62964,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64600,7 +63057,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64642,7 +63098,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64689,7 +63144,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -64724,7 +63178,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64739,8 +63192,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64783,10 +63235,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -64829,7 +63281,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64845,7 +63296,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64861,7 +63311,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64891,7 +63340,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64971,7 +63419,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -64992,8 +63439,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65011,14 +63457,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -65254,8 +63698,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65295,31 +63738,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65329,15 +63771,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -65400,7 +63841,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -65470,14 +63910,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -65507,7 +63945,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -65554,7 +63991,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -65578,14 +64014,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -65601,7 +64035,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -65625,14 +64058,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -65698,7 +64129,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65775,7 +64205,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65791,7 +64220,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65834,14 +64262,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65871,7 +64297,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65901,7 +64326,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -65931,7 +64355,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -66008,7 +64431,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -66102,7 +64524,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -66126,7 +64547,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -66168,7 +64588,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -66215,7 +64634,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -66250,7 +64668,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -66266,7 +64683,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66308,7 +64724,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66396,14 +64811,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66419,7 +64832,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66443,14 +64855,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66473,7 +64883,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66497,14 +64906,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66520,7 +64927,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66544,14 +64950,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66574,7 +64978,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66598,14 +65001,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66621,7 +65022,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66645,14 +65045,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66683,7 +65081,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -66720,7 +65117,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66744,14 +65140,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66767,7 +65161,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66791,14 +65184,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66814,7 +65205,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66838,14 +65228,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66861,7 +65249,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66884,7 +65271,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -66907,7 +65293,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -67152,14 +65537,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -67182,7 +65565,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -67205,7 +65587,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -67229,7 +65610,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -67465,14 +65845,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67586,7 +65965,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67613,7 +65992,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67634,7 +66013,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67692,14 +66071,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67721,44 +66100,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67774,7 +66150,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67788,10 +66163,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -67835,7 +66210,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67865,7 +66239,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67907,7 +66280,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -67928,7 +66300,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -67996,7 +66367,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68019,7 +66389,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68061,14 +66430,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68084,7 +66451,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68107,7 +66473,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68130,7 +66495,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68174,7 +66538,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68209,7 +66572,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -68256,7 +66618,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68279,7 +66640,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -68515,7 +66875,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68552,7 +66911,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68664,7 +67022,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68688,7 +67045,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68723,7 +67079,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68746,7 +67101,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68789,7 +67143,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68832,7 +67185,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68891,7 +67243,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -68912,7 +67263,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -68929,8 +67279,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69034,7 +67383,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -69070,7 +67418,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69129,7 +67476,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69160,7 +67506,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69211,7 +67556,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69228,14 +67572,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69272,7 +67614,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69348,7 +67689,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69385,7 +67725,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69408,7 +67747,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69457,7 +67795,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69511,14 +67848,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69599,7 +67934,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69616,7 +67950,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69633,7 +67966,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69658,7 +67990,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69719,7 +68050,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69854,7 +68184,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69938,14 +68267,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69961,7 +68288,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -69978,14 +68304,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70015,7 +68339,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70045,7 +68368,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70075,7 +68397,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70090,8 +68411,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70200,8 +68520,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70216,8 +68535,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70253,8 +68571,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -70262,7 +68579,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70313,7 +68629,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70329,7 +68644,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70345,7 +68659,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70361,7 +68674,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70391,7 +68703,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70414,7 +68725,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70430,7 +68740,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70507,7 +68816,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70523,7 +68831,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70600,7 +68907,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70694,7 +69000,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70736,7 +69041,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70783,7 +69087,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -70818,7 +69121,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70833,8 +69135,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70877,10 +69178,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -70923,7 +69224,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70939,7 +69239,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70955,7 +69254,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -70985,7 +69283,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71065,7 +69362,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71086,8 +69382,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71105,14 +69400,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -71348,8 +69641,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71389,31 +69681,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71423,15 +69714,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -71494,7 +69784,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -71564,14 +69853,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -71601,7 +69888,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -71648,7 +69934,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -71672,14 +69957,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -71695,7 +69978,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -71719,14 +70001,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -71792,7 +70072,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71869,7 +70148,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71885,7 +70163,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71928,14 +70205,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71965,7 +70240,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -71995,7 +70269,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -72025,7 +70298,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -72102,7 +70374,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -72196,7 +70467,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -72220,7 +70490,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -72262,7 +70531,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -72309,7 +70577,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -72344,7 +70611,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -72360,7 +70626,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72402,7 +70667,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72490,14 +70754,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72513,7 +70775,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72537,14 +70798,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72567,7 +70826,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72591,14 +70849,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72614,7 +70870,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72638,14 +70893,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72668,7 +70921,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72692,14 +70944,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72715,7 +70965,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72739,14 +70988,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72777,7 +71024,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -72814,7 +71060,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72838,14 +71083,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72861,7 +71104,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72885,14 +71127,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72908,7 +71148,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72932,14 +71171,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72955,7 +71192,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -72978,7 +71214,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -73001,7 +71236,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -73246,14 +71480,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -73276,7 +71508,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -73299,7 +71530,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -73323,7 +71553,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -73559,14 +71788,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73680,7 +71908,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73707,7 +71935,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73728,7 +71956,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73786,14 +72014,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73815,44 +72043,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73868,7 +72093,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73882,10 +72106,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -73929,7 +72153,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -73959,7 +72182,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74001,7 +72223,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -74022,7 +72243,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74090,7 +72310,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74113,7 +72332,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74155,14 +72373,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74178,7 +72394,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74201,7 +72416,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74224,7 +72438,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74268,7 +72481,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74303,7 +72515,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -74350,7 +72561,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74373,7 +72583,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -74609,7 +72818,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74646,7 +72854,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74758,7 +72965,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74782,7 +72988,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74817,7 +73022,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74840,7 +73044,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74883,7 +73086,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74926,7 +73128,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -74985,7 +73186,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -75006,7 +73206,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75023,8 +73222,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75128,7 +73326,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -75164,7 +73361,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75223,7 +73419,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75254,7 +73449,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75305,7 +73499,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75322,14 +73515,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75366,7 +73557,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75442,7 +73632,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75479,7 +73668,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75502,7 +73690,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75551,7 +73738,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75605,14 +73791,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75693,7 +73877,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75710,7 +73893,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75727,7 +73909,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75752,7 +73933,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75813,7 +73993,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -75948,7 +74127,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76032,14 +74210,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76055,7 +74231,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76072,14 +74247,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76109,7 +74282,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76139,7 +74311,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76169,7 +74340,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76184,8 +74354,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76294,8 +74463,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76310,8 +74478,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76347,8 +74514,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -76356,7 +74522,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76407,7 +74572,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76423,7 +74587,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76439,7 +74602,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76455,7 +74617,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76485,7 +74646,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76508,7 +74668,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76524,7 +74683,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76601,7 +74759,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76617,7 +74774,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76694,7 +74850,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76788,7 +74943,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76830,7 +74984,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76877,7 +75030,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -76912,7 +75064,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76927,8 +75078,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -76971,10 +75121,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -77017,7 +75167,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77033,7 +75182,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77049,7 +75197,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77079,7 +75226,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77159,7 +75305,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77180,8 +75325,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77199,14 +75343,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -77442,8 +75584,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77483,31 +75624,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77517,15 +75657,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -77588,7 +75727,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -77658,14 +75796,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -77695,7 +75831,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -77742,7 +75877,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -77766,14 +75900,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -77789,7 +75921,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -77813,14 +75944,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -77886,7 +76015,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77963,7 +76091,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -77979,7 +76106,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -78022,14 +76148,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -78059,7 +76183,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -78089,7 +76212,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -78119,7 +76241,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -78196,7 +76317,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -78290,7 +76410,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -78314,7 +76433,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -78356,7 +76474,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -78403,7 +76520,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -78438,7 +76554,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -78454,7 +76569,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78496,7 +76610,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78584,14 +76697,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78607,7 +76718,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78631,14 +76741,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78661,7 +76769,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78685,14 +76792,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78708,7 +76813,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78732,14 +76836,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78762,7 +76864,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78786,14 +76887,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78809,7 +76908,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78833,14 +76931,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78871,7 +76967,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -78908,7 +77003,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78932,14 +77026,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78955,7 +77047,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -78979,14 +77070,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79002,7 +77091,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79026,14 +77114,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79049,7 +77135,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79072,7 +77157,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79095,7 +77179,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -79340,14 +77423,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79370,7 +77451,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79393,7 +77473,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -79417,7 +77496,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -79653,14 +77731,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79774,7 +77851,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79801,7 +77878,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79822,7 +77899,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79880,14 +77957,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79909,44 +77986,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79962,7 +78036,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -79976,10 +78049,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -80023,7 +78096,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80053,7 +78125,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80095,7 +78166,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -80116,7 +78186,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80184,7 +78253,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80207,7 +78275,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80249,14 +78316,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80272,7 +78337,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80295,7 +78359,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80318,7 +78381,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80362,7 +78424,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80397,7 +78458,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -80444,7 +78504,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80467,7 +78526,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -80703,7 +78761,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80740,7 +78797,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80852,7 +78908,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80876,7 +78931,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80911,7 +78965,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80934,7 +78987,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -80977,7 +79029,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81020,7 +79071,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81079,7 +79129,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -81100,7 +79149,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81117,8 +79165,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81222,7 +79269,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -81258,7 +79304,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81317,7 +79362,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81348,7 +79392,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81399,7 +79442,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81416,14 +79458,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81460,7 +79500,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81536,7 +79575,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81573,7 +79611,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81596,7 +79633,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81645,7 +79681,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81699,14 +79734,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81787,7 +79820,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81804,7 +79836,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81821,7 +79852,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81846,7 +79876,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -81907,7 +79936,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82042,7 +80070,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82126,14 +80153,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82149,7 +80174,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82166,14 +80190,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82203,7 +80225,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82233,7 +80254,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82263,7 +80283,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82278,8 +80297,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82388,8 +80406,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82404,8 +80421,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82441,8 +80457,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -82450,7 +80465,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82501,7 +80515,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82517,7 +80530,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82533,7 +80545,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82549,7 +80560,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82579,7 +80589,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82602,7 +80611,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82618,7 +80626,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82695,7 +80702,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82711,7 +80717,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82788,7 +80793,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82882,7 +80886,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82924,7 +80927,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -82971,7 +80973,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -83006,7 +81007,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83021,8 +81021,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83065,10 +81064,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -83111,7 +81110,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83127,7 +81125,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83143,7 +81140,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83173,7 +81169,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83253,7 +81248,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83274,8 +81268,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83293,14 +81286,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -83536,8 +81527,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83577,31 +81567,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -83611,15 +81600,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -83682,7 +81670,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -83752,14 +81739,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -83789,7 +81774,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -83836,7 +81820,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -83860,14 +81843,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -83883,7 +81864,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -83907,14 +81887,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -83980,7 +81958,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -84057,7 +82034,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -84073,7 +82049,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -84116,14 +82091,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -84153,7 +82126,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -84183,7 +82155,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -84213,7 +82184,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -84290,7 +82260,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -84384,7 +82353,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -84408,7 +82376,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -84450,7 +82417,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -84497,7 +82463,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -84532,7 +82497,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -84548,7 +82512,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84590,7 +82553,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84678,14 +82640,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84701,7 +82661,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84725,14 +82684,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84755,7 +82712,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84779,14 +82735,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84802,7 +82756,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84826,14 +82779,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84856,7 +82807,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84880,14 +82830,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84903,7 +82851,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84927,14 +82874,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -84965,7 +82910,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85002,7 +82946,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85026,14 +82969,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85049,7 +82990,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85073,14 +83013,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85096,7 +83034,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85120,14 +83057,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85143,7 +83078,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85166,7 +83100,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85189,7 +83122,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -85434,14 +83366,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85464,7 +83394,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85487,7 +83416,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -85511,7 +83439,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -85747,14 +83674,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85868,7 +83794,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85895,7 +83821,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85916,7 +83842,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -85974,14 +83900,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86003,44 +83929,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86056,7 +83979,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86070,10 +83992,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -86117,7 +84039,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86147,7 +84068,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86189,7 +84109,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -86210,7 +84129,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86278,7 +84196,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86301,7 +84218,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86343,14 +84259,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86366,7 +84280,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86389,7 +84302,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86412,7 +84324,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86456,7 +84367,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86491,7 +84401,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -86538,7 +84447,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86561,7 +84469,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -86797,7 +84704,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86834,7 +84740,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86946,7 +84851,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -86970,7 +84874,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87005,7 +84908,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87028,7 +84930,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87071,7 +84972,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87114,7 +85014,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87173,7 +85072,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -87194,7 +85092,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87211,8 +85108,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87316,7 +85212,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -87352,7 +85247,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87411,7 +85305,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87442,7 +85335,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87493,7 +85385,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87510,14 +85401,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87554,7 +85443,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87630,7 +85518,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87667,7 +85554,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87690,7 +85576,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87739,7 +85624,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87793,14 +85677,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87881,7 +85763,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87898,7 +85779,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87915,7 +85795,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -87940,7 +85819,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88001,7 +85879,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88136,7 +86013,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88220,14 +86096,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88243,7 +86117,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88260,14 +86133,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88297,7 +86168,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88327,7 +86197,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88357,7 +86226,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88372,8 +86240,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88482,8 +86349,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88498,8 +86364,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88535,8 +86400,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -88544,7 +86408,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88595,7 +86458,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88611,7 +86473,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88627,7 +86488,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88643,7 +86503,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88673,7 +86532,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88696,7 +86554,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88712,7 +86569,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88789,7 +86645,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88805,7 +86660,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88882,7 +86736,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -88976,7 +86829,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89018,7 +86870,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89065,7 +86916,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -89100,7 +86950,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89115,8 +86964,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89159,10 +87007,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -89205,7 +87053,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89221,7 +87068,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89237,7 +87083,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89267,7 +87112,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89347,7 +87191,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89368,8 +87211,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89387,14 +87229,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -89630,8 +87470,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89671,31 +87510,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -89705,15 +87543,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -89776,7 +87613,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -89846,14 +87682,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -89883,7 +87717,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -89930,7 +87763,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -89954,14 +87786,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -89977,7 +87807,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90001,14 +87830,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90074,7 +87901,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -90151,7 +87977,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -90167,7 +87992,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -90210,14 +88034,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -90247,7 +88069,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -90277,7 +88098,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -90307,7 +88127,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -90384,7 +88203,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -90478,7 +88296,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -90502,7 +88319,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -90544,7 +88360,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -90591,7 +88406,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -90626,7 +88440,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -90642,7 +88455,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90684,7 +88496,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90772,14 +88583,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90795,7 +88604,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90819,14 +88627,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90849,7 +88655,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90873,14 +88678,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90896,7 +88699,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90920,14 +88722,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90950,7 +88750,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90974,14 +88773,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -90997,7 +88794,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91021,14 +88817,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91059,7 +88853,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -91096,7 +88889,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91120,14 +88912,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91143,7 +88933,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91167,14 +88956,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91190,7 +88977,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91214,14 +89000,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91237,7 +89021,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91260,7 +89043,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91283,7 +89065,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -91528,14 +89309,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91558,7 +89337,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91581,7 +89359,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -91605,7 +89382,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -91841,14 +89617,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -91962,7 +89737,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -91989,7 +89764,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92010,7 +89785,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92068,14 +89843,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92097,44 +89872,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92150,7 +89922,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92164,10 +89935,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -92211,7 +89982,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92241,7 +90011,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92283,7 +90052,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -92304,7 +90072,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92372,7 +90139,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92395,7 +90161,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92437,14 +90202,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92460,7 +90223,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92483,7 +90245,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92506,7 +90267,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92550,7 +90310,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92585,7 +90344,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -92632,7 +90390,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92655,7 +90412,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -92891,7 +90647,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -92928,7 +90683,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93040,7 +90794,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93064,7 +90817,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93099,7 +90851,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93122,7 +90873,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93165,7 +90915,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93208,7 +90957,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93267,7 +91015,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -93288,7 +91035,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93305,8 +91051,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93410,7 +91155,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -93446,7 +91190,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93505,7 +91248,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93536,7 +91278,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93587,7 +91328,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93604,14 +91344,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93648,7 +91386,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93724,7 +91461,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93761,7 +91497,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93784,7 +91519,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93833,7 +91567,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93887,14 +91620,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93975,7 +91706,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -93992,7 +91722,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94009,7 +91738,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94034,7 +91762,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94095,7 +91822,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94230,7 +91956,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94314,14 +92039,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94337,7 +92060,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94354,14 +92076,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94391,7 +92111,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94421,7 +92140,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94451,7 +92169,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94466,8 +92183,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94576,8 +92292,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94592,8 +92307,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94629,8 +92343,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -94638,7 +92351,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94689,7 +92401,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94705,7 +92416,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94721,7 +92431,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94737,7 +92446,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94767,7 +92475,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94790,7 +92497,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94806,7 +92512,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94883,7 +92588,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94899,7 +92603,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -94976,7 +92679,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95070,7 +92772,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95112,7 +92813,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95159,7 +92859,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -95194,7 +92893,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95209,8 +92907,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95253,10 +92950,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -95299,7 +92996,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95315,7 +93011,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95331,7 +93026,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95361,7 +93055,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95441,7 +93134,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95462,8 +93154,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95481,14 +93172,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -95724,8 +93413,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95765,31 +93453,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -95799,15 +93486,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -95870,7 +93556,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -95940,14 +93625,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -95977,7 +93660,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -96024,7 +93706,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96048,14 +93729,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96071,7 +93750,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96095,14 +93773,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96168,7 +93844,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -96245,7 +93920,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -96261,7 +93935,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -96304,14 +93977,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -96341,7 +94012,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -96371,7 +94041,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -96401,7 +94070,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -96478,7 +94146,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -96572,7 +94239,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -96596,7 +94262,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -96638,7 +94303,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -96685,7 +94349,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -96720,7 +94383,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -96736,7 +94398,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96778,7 +94439,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96866,14 +94526,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96889,7 +94547,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96913,14 +94570,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96943,7 +94598,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96967,14 +94621,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -96990,7 +94642,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97014,14 +94665,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97044,7 +94693,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97068,14 +94716,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97091,7 +94737,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97115,14 +94760,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97153,7 +94796,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -97190,7 +94832,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97214,14 +94855,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97237,7 +94876,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97261,14 +94899,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97284,7 +94920,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97308,14 +94943,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97331,7 +94964,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97354,7 +94986,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97377,7 +95008,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -97622,14 +95252,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97652,7 +95280,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97675,7 +95302,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -97699,7 +95325,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -97935,14 +95560,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98056,7 +95680,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98083,7 +95707,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98104,7 +95728,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98162,14 +95786,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98191,44 +95815,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98244,7 +95865,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98258,10 +95878,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -98305,7 +95925,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98335,7 +95954,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98377,7 +95995,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -98398,7 +96015,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98466,7 +96082,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98489,7 +96104,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98531,14 +96145,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98554,7 +96166,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98577,7 +96188,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98600,7 +96210,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98644,7 +96253,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98679,7 +96287,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -98726,7 +96333,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -98749,7 +96355,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -98985,7 +96590,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99022,7 +96626,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99134,7 +96737,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99158,7 +96760,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99193,7 +96794,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99216,7 +96816,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99259,7 +96858,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99302,7 +96900,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99361,7 +96958,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -99382,7 +96978,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99399,8 +96994,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99504,7 +97098,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -99540,7 +97133,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99599,7 +97191,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99630,7 +97221,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99681,7 +97271,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99698,14 +97287,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99742,7 +97329,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99818,7 +97404,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99855,7 +97440,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99878,7 +97462,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99927,7 +97510,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -99981,14 +97563,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100069,7 +97649,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100086,7 +97665,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100103,7 +97681,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100128,7 +97705,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100189,7 +97765,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100324,7 +97899,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100408,14 +97982,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100431,7 +98003,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100448,14 +98019,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100485,7 +98054,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100515,7 +98083,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100545,7 +98112,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100560,8 +98126,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100670,8 +98235,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100686,8 +98250,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100723,8 +98286,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -100732,7 +98294,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100783,7 +98344,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100799,7 +98359,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100815,7 +98374,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100831,7 +98389,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100861,7 +98418,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100884,7 +98440,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100900,7 +98455,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100977,7 +98531,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -100993,7 +98546,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101070,7 +98622,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101164,7 +98715,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101206,7 +98756,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101253,7 +98802,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -101288,7 +98836,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101303,8 +98850,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101347,10 +98893,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -101393,7 +98939,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101409,7 +98954,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101425,7 +98969,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101455,7 +98998,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101535,7 +99077,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101556,8 +99097,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101575,14 +99115,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -101818,8 +99356,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101859,31 +99396,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -101893,15 +99429,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -101964,7 +99499,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -102034,14 +99568,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -102071,7 +99603,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -102118,7 +99649,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -102142,14 +99672,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -102165,7 +99693,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -102189,14 +99716,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -102262,7 +99787,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -102339,7 +99863,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -102355,7 +99878,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -102398,14 +99920,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -102435,7 +99955,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -102465,7 +99984,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -102495,7 +100013,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -102572,7 +100089,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -102666,7 +100182,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -102690,7 +100205,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -102732,7 +100246,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -102779,7 +100292,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -102814,7 +100326,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -102830,7 +100341,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -102872,7 +100382,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -102960,14 +100469,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -102983,7 +100490,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103007,14 +100513,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103037,7 +100541,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103061,14 +100564,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103084,7 +100585,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103108,14 +100608,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103138,7 +100636,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103162,14 +100659,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103185,7 +100680,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103209,14 +100703,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103247,7 +100739,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -103284,7 +100775,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103308,14 +100798,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103331,7 +100819,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103355,14 +100842,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103378,7 +100863,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103402,14 +100886,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103425,7 +100907,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103448,7 +100929,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103471,7 +100951,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -103716,14 +101195,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103746,7 +101223,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103769,7 +101245,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -103793,7 +101268,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -104029,14 +101503,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104150,7 +101623,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104177,7 +101650,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104198,7 +101671,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104256,14 +101729,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104285,44 +101758,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104338,7 +101808,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104352,10 +101821,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -104399,7 +101868,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104429,7 +101897,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104471,7 +101938,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -104492,7 +101958,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104560,7 +102025,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104583,7 +102047,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104625,14 +102088,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104648,7 +102109,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104671,7 +102131,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104694,7 +102153,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104738,7 +102196,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104773,7 +102230,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -104820,7 +102276,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -104843,7 +102298,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -105079,7 +102533,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105116,7 +102569,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105228,7 +102680,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105252,7 +102703,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105287,7 +102737,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105310,7 +102759,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105353,7 +102801,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105396,7 +102843,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105455,7 +102901,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -105476,7 +102921,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105493,8 +102937,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105598,7 +103041,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -105634,7 +103076,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105693,7 +103134,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105724,7 +103164,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105775,7 +103214,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105792,14 +103230,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105836,7 +103272,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105912,7 +103347,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105949,7 +103383,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -105972,7 +103405,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106021,7 +103453,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106075,14 +103506,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106163,7 +103592,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106180,7 +103608,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106197,7 +103624,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106222,7 +103648,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106283,7 +103708,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106418,7 +103842,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106502,14 +103925,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106525,7 +103946,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106542,14 +103962,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106579,7 +103997,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106609,7 +104026,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106639,7 +104055,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106654,8 +104069,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106764,8 +104178,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106780,8 +104193,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106817,8 +104229,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -106826,7 +104237,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106877,7 +104287,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106893,7 +104302,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106909,7 +104317,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106925,7 +104332,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106955,7 +104361,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106978,7 +104383,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -106994,7 +104398,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107071,7 +104474,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107087,7 +104489,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107164,7 +104565,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107258,7 +104658,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107300,7 +104699,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107347,7 +104745,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -107382,7 +104779,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107397,8 +104793,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107441,10 +104836,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -107487,7 +104882,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107503,7 +104897,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107519,7 +104912,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107549,7 +104941,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107629,7 +105020,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107650,8 +105040,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107669,14 +105058,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -107912,8 +105299,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107953,31 +105339,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -107987,15 +105372,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -108058,7 +105442,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", "name": "PickupLocationListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", @@ -108119,7 +105502,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -108189,14 +105571,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -108226,7 +105606,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -108273,7 +105652,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -108297,14 +105675,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -108320,7 +105696,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -108344,14 +105719,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -108417,7 +105790,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108494,7 +105866,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108510,7 +105881,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108553,14 +105923,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108590,7 +105958,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108620,7 +105987,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108650,7 +106016,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108727,7 +106092,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108821,7 +106185,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108845,7 +106208,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108887,7 +106249,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108934,7 +106295,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -108969,7 +106329,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -108985,7 +106344,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109027,7 +106385,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109115,14 +106472,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109138,7 +106493,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109162,14 +106516,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109192,7 +106544,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109216,14 +106567,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109239,7 +106588,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109263,14 +106611,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109293,7 +106639,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109317,14 +106662,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109340,7 +106683,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109364,14 +106706,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109402,7 +106742,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -109439,7 +106778,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109463,14 +106801,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109486,7 +106822,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109510,14 +106845,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109533,7 +106866,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109557,14 +106889,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109580,7 +106910,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109603,7 +106932,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109626,7 +106954,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -109871,14 +107198,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109901,7 +107226,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109924,7 +107248,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -109948,7 +107271,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -110184,14 +107506,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110305,7 +107626,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110332,7 +107653,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110353,7 +107674,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110411,14 +107732,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110440,44 +107761,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110493,7 +107811,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110507,10 +107824,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -110554,7 +107871,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110584,7 +107900,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110626,7 +107941,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -110647,7 +107961,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110715,7 +108028,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110738,7 +108050,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110780,14 +108091,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110803,7 +108112,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110826,7 +108134,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110849,7 +108156,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110893,7 +108199,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110928,7 +108233,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -110975,7 +108279,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -110998,7 +108301,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -111234,7 +108536,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111271,7 +108572,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111383,7 +108683,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111407,7 +108706,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111442,7 +108740,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111465,7 +108762,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111508,7 +108804,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111551,7 +108846,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111610,7 +108904,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -111631,7 +108924,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111648,8 +108940,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111753,7 +109044,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -111789,7 +109079,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111848,7 +109137,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111879,7 +109167,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111930,7 +109217,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111947,14 +109233,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -111991,7 +109275,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112067,7 +109350,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112104,7 +109386,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112127,7 +109408,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112176,7 +109456,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112230,14 +109509,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112318,7 +109595,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112335,7 +109611,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112352,7 +109627,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112377,7 +109651,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112438,7 +109711,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112573,7 +109845,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112657,14 +109928,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112680,7 +109949,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112697,14 +109965,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112734,7 +110000,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112764,7 +110029,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112794,7 +110058,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112809,8 +110072,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112919,8 +110181,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112935,8 +110196,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -112972,8 +110232,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -112981,7 +110240,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113032,7 +110290,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113048,7 +110305,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113064,7 +110320,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113080,7 +110335,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113110,7 +110364,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113133,7 +110386,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113149,7 +110401,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113226,7 +110477,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113242,7 +110492,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113319,7 +110568,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113413,7 +110661,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113455,7 +110702,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113502,7 +110748,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -113537,7 +110782,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113552,8 +110796,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113596,10 +110839,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -113642,7 +110885,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113658,7 +110900,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113674,7 +110915,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113704,7 +110944,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113784,7 +111023,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113805,8 +111043,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -113824,14 +111061,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -114067,8 +111302,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -114108,31 +111342,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -114142,15 +111375,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -114213,7 +111445,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", "name": "PickupLocationListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", @@ -114274,7 +111505,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -114344,14 +111574,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -114381,7 +111609,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -114428,7 +111655,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -114452,14 +111678,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -114475,7 +111699,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -114499,14 +111722,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -114572,7 +111793,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -114649,7 +111869,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -114665,7 +111884,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -114708,14 +111926,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -114745,7 +111961,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -114775,7 +111990,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -114805,7 +112019,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -114882,7 +112095,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -114976,7 +112188,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -115000,7 +112211,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -115042,7 +112252,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -115089,7 +112298,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -115124,7 +112332,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -115140,7 +112347,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115182,7 +112388,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115270,14 +112475,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115293,7 +112496,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115317,14 +112519,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115347,7 +112547,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115371,14 +112570,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115394,7 +112591,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115418,14 +112614,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115448,7 +112642,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115472,14 +112665,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115495,7 +112686,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115519,14 +112709,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115557,7 +112745,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -115594,7 +112781,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115618,14 +112804,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115641,7 +112825,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115665,14 +112848,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115688,7 +112869,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115712,14 +112892,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115735,7 +112913,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115758,7 +112935,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -115781,7 +112957,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -116026,14 +113201,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -116056,7 +113229,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -116079,7 +113251,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -116103,7 +113274,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -116339,14 +113509,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116460,7 +113629,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116487,7 +113656,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116508,7 +113677,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116566,14 +113735,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116595,44 +113764,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116648,7 +113814,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116662,10 +113827,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -116709,7 +113874,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116739,7 +113903,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116781,7 +113944,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -116802,7 +113964,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116870,7 +114031,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116893,7 +114053,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116935,14 +114094,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116958,7 +114115,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -116981,7 +114137,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117004,7 +114159,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117048,7 +114202,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117083,7 +114236,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -117130,7 +114282,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117153,7 +114304,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -117389,7 +114539,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117426,7 +114575,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117538,7 +114686,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117562,7 +114709,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117597,7 +114743,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117620,7 +114765,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117663,7 +114807,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117706,7 +114849,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117765,7 +114907,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -117786,7 +114927,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117803,8 +114943,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -117908,7 +115047,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -117944,7 +115082,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118003,7 +115140,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118034,7 +115170,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118085,7 +115220,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118102,14 +115236,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118146,7 +115278,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118222,7 +115353,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118259,7 +115389,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118282,7 +115411,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118331,7 +115459,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118385,14 +115512,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118473,7 +115598,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118490,7 +115614,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118507,7 +115630,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118532,7 +115654,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118593,7 +115714,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118728,7 +115848,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118812,14 +115931,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118835,7 +115952,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118852,14 +115968,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118889,7 +116003,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118919,7 +116032,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118949,7 +116061,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -118964,8 +116075,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119074,8 +116184,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119090,8 +116199,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119127,8 +116235,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -119136,7 +116243,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119187,7 +116293,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119203,7 +116308,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119219,7 +116323,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119235,7 +116338,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119265,7 +116367,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119288,7 +116389,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119304,7 +116404,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119381,7 +116480,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119397,7 +116495,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119474,7 +116571,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119568,7 +116664,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119610,7 +116705,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119657,7 +116751,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -119692,7 +116785,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119707,8 +116799,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119751,10 +116842,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -119797,7 +116888,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119813,7 +116903,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119829,7 +116918,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119859,7 +116947,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119939,7 +117026,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119960,8 +117046,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -119979,14 +117064,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -120222,8 +117305,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -120263,31 +117345,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -120297,15 +117378,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -120368,7 +117448,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", "name": "PickupLocationItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", @@ -120429,7 +117508,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -120512,7 +117590,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -120748,7 +117825,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -120816,7 +117892,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -120886,14 +117961,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -120923,7 +117996,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -120970,7 +118042,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -120994,14 +118065,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121017,7 +118086,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121041,14 +118109,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121114,7 +118180,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -121191,7 +118256,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -121207,7 +118271,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -121250,14 +118313,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -121287,7 +118348,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -121317,7 +118377,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -121347,7 +118406,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -121424,7 +118482,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -121518,7 +118575,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -121542,7 +118598,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -121584,7 +118639,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -121631,7 +118685,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -121666,7 +118719,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -121682,7 +118734,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121724,7 +118775,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121812,14 +118862,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121835,7 +118883,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121859,14 +118906,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121889,7 +118934,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121913,14 +118957,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121936,7 +118978,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121960,14 +119001,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -121990,7 +119029,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122014,14 +119052,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122037,7 +119073,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122061,14 +119096,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122099,7 +119132,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -122136,7 +119168,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122160,14 +119191,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122183,7 +119212,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122207,14 +119235,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122230,7 +119256,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122254,14 +119279,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122277,7 +119300,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122300,7 +119322,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122323,7 +119344,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -122568,14 +119588,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122598,7 +119616,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122621,7 +119638,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -122645,7 +119661,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -122881,14 +119896,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123002,7 +120016,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123029,7 +120043,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123050,7 +120064,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123108,14 +120122,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123137,44 +120151,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123190,7 +120201,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123204,10 +120214,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -123251,7 +120261,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123281,7 +120290,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123323,7 +120331,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -123344,7 +120351,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123412,7 +120418,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123435,7 +120440,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123477,14 +120481,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123500,7 +120502,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123523,7 +120524,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123546,7 +120546,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123590,7 +120589,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123625,7 +120623,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -123672,7 +120669,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123695,7 +120691,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -123931,7 +120926,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -123968,7 +120962,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124080,7 +121073,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124104,7 +121096,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124139,7 +121130,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124162,7 +121152,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124205,7 +121194,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124248,7 +121236,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124307,7 +121294,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -124328,7 +121314,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124345,8 +121330,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124450,7 +121434,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -124486,7 +121469,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124545,7 +121527,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124576,7 +121557,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124627,7 +121607,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124644,14 +121623,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124688,7 +121665,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124764,7 +121740,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124801,7 +121776,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124824,7 +121798,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124873,7 +121846,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -124927,14 +121899,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125015,7 +121985,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125032,7 +122001,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125049,7 +122017,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125074,7 +122041,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125135,7 +122101,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125270,7 +122235,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125354,14 +122318,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125377,7 +122339,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125394,14 +122355,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125431,7 +122390,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125461,7 +122419,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125491,7 +122448,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125506,8 +122462,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125616,8 +122571,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125632,8 +122586,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125669,8 +122622,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -125678,7 +122630,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125729,7 +122680,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125745,7 +122695,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125761,7 +122710,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125777,7 +122725,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125807,7 +122754,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125830,7 +122776,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125846,7 +122791,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125923,7 +122867,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -125939,7 +122882,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126016,7 +122958,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126110,7 +123051,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126152,7 +123092,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126199,7 +123138,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -126234,7 +123172,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126249,8 +123186,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126293,10 +123229,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -126339,7 +123275,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126355,7 +123290,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126371,7 +123305,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126401,7 +123334,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126481,7 +123413,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126502,8 +123433,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126521,14 +123451,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -126764,8 +123692,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126805,31 +123732,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -126839,15 +123765,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -126910,7 +123835,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", "name": "PickupPointListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", @@ -126971,7 +123895,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -127041,14 +123964,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -127078,7 +123999,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -127125,7 +124045,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -127149,14 +124068,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -127172,7 +124089,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -127196,14 +124112,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -127269,7 +124183,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -127346,7 +124259,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -127362,7 +124274,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -127405,14 +124316,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -127442,7 +124351,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -127472,7 +124380,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -127502,7 +124409,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -127579,7 +124485,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -127673,7 +124578,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -127697,7 +124601,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -127739,7 +124642,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -127786,7 +124688,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -127821,7 +124722,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -127837,7 +124737,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -127879,7 +124778,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -127967,14 +124865,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -127990,7 +124886,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128014,14 +124909,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128044,7 +124937,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128068,14 +124960,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128091,7 +124981,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128115,14 +125004,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128145,7 +125032,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128169,14 +125055,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128192,7 +125076,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128216,14 +125099,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128254,7 +125135,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -128291,7 +125171,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128315,14 +125194,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128338,7 +125215,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128362,14 +125238,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128385,7 +125259,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128409,14 +125282,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128432,7 +125303,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128455,7 +125325,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128478,7 +125347,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -128723,14 +125591,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128753,7 +125619,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128776,7 +125641,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -128800,7 +125664,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -129036,14 +125899,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129157,7 +126019,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129184,7 +126046,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129205,7 +126067,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129263,14 +126125,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129292,44 +126154,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129345,7 +126204,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129359,10 +126217,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -129406,7 +126264,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129436,7 +126293,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129478,7 +126334,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -129499,7 +126354,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129567,7 +126421,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129590,7 +126443,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129632,14 +126484,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129655,7 +126505,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129678,7 +126527,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129701,7 +126549,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129745,7 +126592,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129780,7 +126626,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -129827,7 +126672,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -129850,7 +126694,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -130086,7 +126929,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130123,7 +126965,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130235,7 +127076,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130259,7 +127099,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130294,7 +127133,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130317,7 +127155,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130360,7 +127197,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130403,7 +127239,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130462,7 +127297,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -130483,7 +127317,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130500,8 +127333,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130605,7 +127437,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -130641,7 +127472,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130700,7 +127530,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130731,7 +127560,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130782,7 +127610,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130799,14 +127626,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130843,7 +127668,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130919,7 +127743,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130956,7 +127779,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -130979,7 +127801,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131028,7 +127849,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131082,14 +127902,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131170,7 +127988,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131187,7 +128004,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131204,7 +128020,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131229,7 +128044,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131290,7 +128104,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131425,7 +128238,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131509,14 +128321,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131532,7 +128342,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131549,14 +128358,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131586,7 +128393,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131616,7 +128422,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131646,7 +128451,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131661,8 +128465,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131771,8 +128574,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131787,8 +128589,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131824,8 +128625,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -131833,7 +128633,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131884,7 +128683,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131900,7 +128698,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131916,7 +128713,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131932,7 +128728,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131962,7 +128757,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -131985,7 +128779,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132001,7 +128794,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132078,7 +128870,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132094,7 +128885,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132171,7 +128961,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132265,7 +129054,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132307,7 +129095,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132354,7 +129141,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -132389,7 +129175,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132404,8 +129189,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132448,10 +129232,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -132494,7 +129278,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132510,7 +129293,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132526,7 +129308,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132556,7 +129337,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132636,7 +129416,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132657,8 +129436,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132676,14 +129454,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -132919,8 +129695,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132960,31 +129735,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -132994,15 +129768,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -133065,7 +129838,6 @@ "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", "name": "PickupPointListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", @@ -133126,7 +129898,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -133196,14 +129967,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -133233,7 +130002,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -133280,7 +130048,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -133304,14 +130071,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -133327,7 +130092,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -133351,14 +130115,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -133424,7 +130186,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133501,7 +130262,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133517,7 +130277,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133560,14 +130319,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133597,7 +130354,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133627,7 +130383,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133657,7 +130412,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133734,7 +130488,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133828,7 +130581,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133852,7 +130604,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133894,7 +130645,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133941,7 +130691,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -133976,7 +130725,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -133992,7 +130740,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134034,7 +130781,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134122,14 +130868,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134145,7 +130889,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134169,14 +130912,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134199,7 +130940,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134223,14 +130963,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134246,7 +130984,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134270,14 +131007,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134300,7 +131035,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134324,14 +131058,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134347,7 +131079,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134371,14 +131102,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134409,7 +131138,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -134446,7 +131174,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134470,14 +131197,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134493,7 +131218,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134517,14 +131241,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134540,7 +131262,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134564,14 +131285,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134587,7 +131306,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134610,7 +131328,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134633,7 +131350,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -134878,14 +131594,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134908,7 +131622,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134931,7 +131644,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -134955,7 +131667,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -135191,14 +131902,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135312,7 +132022,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135339,7 +132049,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135360,7 +132070,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135418,14 +132128,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135447,44 +132157,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135500,7 +132207,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135514,10 +132220,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -135561,7 +132267,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135591,7 +132296,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135633,7 +132337,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -135654,7 +132357,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135722,7 +132424,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135745,7 +132446,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135787,14 +132487,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135810,7 +132508,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135833,7 +132530,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135856,7 +132552,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135900,7 +132595,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -135935,7 +132629,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -135982,7 +132675,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136005,7 +132697,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -136241,7 +132932,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136278,7 +132968,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136390,7 +133079,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136414,7 +133102,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136449,7 +133136,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136472,7 +133158,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136515,7 +133200,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136558,7 +133242,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136617,7 +133300,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -136638,7 +133320,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136655,8 +133336,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136760,7 +133440,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -136796,7 +133475,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136855,7 +133533,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136886,7 +133563,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136937,7 +133613,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136954,14 +133629,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -136998,7 +133671,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137074,7 +133746,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137111,7 +133782,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137134,7 +133804,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137183,7 +133852,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137237,14 +133905,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137325,7 +133991,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137342,7 +134007,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137359,7 +134023,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137384,7 +134047,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137445,7 +134107,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137580,7 +134241,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137664,14 +134324,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137687,7 +134345,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137704,14 +134361,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137741,7 +134396,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137771,7 +134425,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137801,7 +134454,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137816,8 +134468,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137926,8 +134577,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137942,8 +134592,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -137979,8 +134628,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -137988,7 +134636,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138039,7 +134686,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138055,7 +134701,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138071,7 +134716,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138087,7 +134731,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138117,7 +134760,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138140,7 +134782,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138156,7 +134797,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138233,7 +134873,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138249,7 +134888,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138326,7 +134964,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138420,7 +135057,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138462,7 +135098,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138509,7 +135144,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -138544,7 +135178,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138559,8 +135192,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138603,10 +135235,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -138649,7 +135281,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138665,7 +135296,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138681,7 +135311,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138711,7 +135340,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138791,7 +135419,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138812,8 +135439,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -138831,14 +135457,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -139074,8 +135698,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139115,31 +135738,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139149,15 +135771,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -139220,7 +135841,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -139290,14 +135910,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -139327,7 +135945,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -139374,7 +135991,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -139398,14 +136014,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -139421,7 +136035,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -139445,14 +136058,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -139518,7 +136129,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139595,7 +136205,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139611,7 +136220,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139654,14 +136262,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139691,7 +136297,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139721,7 +136326,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139751,7 +136355,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139828,7 +136431,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139922,7 +136524,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139946,7 +136547,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -139988,7 +136588,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -140035,7 +136634,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -140070,7 +136668,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -140086,7 +136683,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140128,7 +136724,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140216,14 +136811,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140239,7 +136832,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140263,14 +136855,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140293,7 +136883,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140317,14 +136906,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140340,7 +136927,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140364,14 +136950,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140394,7 +136978,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140418,14 +137001,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140441,7 +137022,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140465,14 +137045,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140503,7 +137081,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -140540,7 +137117,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140564,14 +137140,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140587,7 +137161,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140611,14 +137184,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140634,7 +137205,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140658,14 +137228,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140681,7 +137249,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140704,7 +137271,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -140727,7 +137293,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -140972,14 +137537,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -141002,7 +137565,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -141025,7 +137587,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -141049,7 +137610,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -141285,14 +137845,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141406,7 +137965,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141433,7 +137992,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141454,7 +138013,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141512,14 +138071,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141541,44 +138100,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141594,7 +138150,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141608,10 +138163,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -141655,7 +138210,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141685,7 +138239,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141727,7 +138280,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -141748,7 +138300,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141816,7 +138367,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141839,7 +138389,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141881,14 +138430,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141904,7 +138451,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141927,7 +138473,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141950,7 +138495,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -141994,7 +138538,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142029,7 +138572,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -142076,7 +138618,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142099,7 +138640,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -142335,7 +138875,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142372,7 +138911,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142484,7 +139022,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142508,7 +139045,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142543,7 +139079,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142566,7 +139101,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142609,7 +139143,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142652,7 +139185,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142711,7 +139243,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -142732,7 +139263,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142749,8 +139279,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142854,7 +139383,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -142890,7 +139418,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142949,7 +139476,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -142980,7 +139506,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143031,7 +139556,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143048,14 +139572,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143092,7 +139614,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143168,7 +139689,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143205,7 +139725,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143228,7 +139747,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143277,7 +139795,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143331,14 +139848,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143419,7 +139934,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143436,7 +139950,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143453,7 +139966,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143478,7 +139990,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143539,7 +140050,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143674,7 +140184,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143758,14 +140267,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143781,7 +140288,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143798,14 +140304,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143835,7 +140339,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143865,7 +140368,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143895,7 +140397,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -143910,8 +140411,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144020,8 +140520,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144036,8 +140535,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144073,8 +140571,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -144082,7 +140579,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144133,7 +140629,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144149,7 +140644,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144165,7 +140659,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144181,7 +140674,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144211,7 +140703,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144234,7 +140725,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144250,7 +140740,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144327,7 +140816,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144343,7 +140831,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144420,7 +140907,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144514,7 +141000,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144556,7 +141041,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144603,7 +141087,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -144638,7 +141121,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144653,8 +141135,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144697,10 +141178,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -144743,7 +141224,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144759,7 +141239,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144775,7 +141254,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144805,7 +141283,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144885,7 +141362,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144906,8 +141382,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -144925,14 +141400,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -145168,8 +141641,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145209,31 +141681,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145243,15 +141714,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -145314,7 +141784,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -145384,14 +141853,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -145421,7 +141888,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -145468,7 +141934,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -145492,14 +141957,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -145515,7 +141978,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -145539,14 +142001,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -145612,7 +142072,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145689,7 +142148,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145705,7 +142163,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145748,14 +142205,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145785,7 +142240,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145815,7 +142269,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145845,7 +142298,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -145922,7 +142374,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -146016,7 +142467,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -146040,7 +142490,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -146082,7 +142531,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -146129,7 +142577,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -146164,7 +142611,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -146180,7 +142626,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146222,7 +142667,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146310,14 +142754,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146333,7 +142775,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146357,14 +142798,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146387,7 +142826,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146411,14 +142849,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146434,7 +142870,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146458,14 +142893,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146488,7 +142921,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146512,14 +142944,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146535,7 +142965,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146559,14 +142988,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146597,7 +143024,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -146634,7 +143060,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146658,14 +143083,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146681,7 +143104,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146705,14 +143127,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146728,7 +143148,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146752,14 +143171,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146775,7 +143192,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146798,7 +143214,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -146821,7 +143236,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -147066,14 +143480,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -147096,7 +143508,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -147119,7 +143530,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -147143,7 +143553,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -147379,14 +143788,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147500,7 +143908,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147527,7 +143935,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147548,7 +143956,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147606,14 +144014,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147635,44 +144043,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147688,7 +144093,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147702,10 +144106,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -147749,7 +144153,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147779,7 +144182,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147821,7 +144223,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -147842,7 +144243,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147910,7 +144310,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147933,7 +144332,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147975,14 +144373,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -147998,7 +144394,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148021,7 +144416,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148044,7 +144438,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148088,7 +144481,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148123,7 +144515,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -148170,7 +144561,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148193,7 +144583,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -148429,7 +144818,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148466,7 +144854,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148578,7 +144965,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148602,7 +144988,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148637,7 +145022,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148660,7 +145044,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148703,7 +145086,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148746,7 +145128,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148805,7 +145186,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -148826,7 +145206,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148843,8 +145222,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -148948,7 +145326,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -148984,7 +145361,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149043,7 +145419,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149074,7 +145449,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149125,7 +145499,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149142,14 +145515,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149186,7 +145557,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149262,7 +145632,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149299,7 +145668,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149322,7 +145690,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149371,7 +145738,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149425,14 +145791,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149513,7 +145877,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149530,7 +145893,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149547,7 +145909,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149572,7 +145933,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149633,7 +145993,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149768,7 +146127,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149852,14 +146210,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149875,7 +146231,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149892,14 +146247,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149929,7 +146282,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149959,7 +146311,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -149989,7 +146340,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150004,8 +146354,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150114,8 +146463,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150130,8 +146478,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150167,8 +146514,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -150176,7 +146522,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150227,7 +146572,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150243,7 +146587,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150259,7 +146602,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150275,7 +146617,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150305,7 +146646,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150328,7 +146668,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150344,7 +146683,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150421,7 +146759,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150437,7 +146774,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150514,7 +146850,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150608,7 +146943,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150650,7 +146984,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150697,7 +147030,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -150732,7 +147064,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150747,8 +147078,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150791,10 +147121,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -150837,7 +147167,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150853,7 +147182,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150869,7 +147197,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150899,7 +147226,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -150979,7 +147305,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151000,8 +147325,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151019,14 +147343,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -151262,8 +147584,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151303,31 +147624,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151337,15 +147657,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -151408,7 +147727,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", "name": "ShippingOptionItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -151476,7 +147794,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", "name": "ShippingOptionItemRenderMode", "description": "The render mode of a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -151492,7 +147809,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151573,7 +147889,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151590,7 +147905,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151632,7 +147946,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151649,7 +147962,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151674,7 +147986,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -151742,7 +148053,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -151812,14 +148122,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -151849,7 +148157,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -151896,7 +148203,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -151920,14 +148226,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -151943,7 +148247,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -151967,14 +148270,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152040,7 +148341,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -152117,7 +148417,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -152133,7 +148432,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -152176,14 +148474,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -152213,7 +148509,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -152243,7 +148538,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -152273,7 +148567,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -152350,7 +148643,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -152444,7 +148736,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -152468,7 +148759,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -152510,7 +148800,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -152557,7 +148846,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -152592,7 +148880,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -152608,7 +148895,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152650,7 +148936,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152738,14 +149023,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152761,7 +149044,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152785,14 +149067,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152815,7 +149095,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152839,14 +149118,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152862,7 +149139,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152886,14 +149162,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152916,7 +149190,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152940,14 +149213,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152963,7 +149234,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -152987,14 +149257,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153025,7 +149293,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153062,7 +149329,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153086,14 +149352,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153109,7 +149373,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153133,14 +149396,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153156,7 +149417,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153180,14 +149440,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153203,7 +149461,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153226,7 +149483,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153249,7 +149505,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -153494,14 +149749,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153524,7 +149777,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153547,7 +149799,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -153571,7 +149822,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -153807,14 +150057,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153928,7 +150177,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153955,7 +150204,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -153976,7 +150225,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154034,14 +150283,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154063,44 +150312,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154116,7 +150362,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154130,10 +150375,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -154177,7 +150422,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154207,7 +150451,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154249,7 +150492,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -154270,7 +150512,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154338,7 +150579,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154361,7 +150601,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154403,14 +150642,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154426,7 +150663,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154449,7 +150685,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154472,7 +150707,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154516,7 +150750,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154551,7 +150784,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -154598,7 +150830,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154621,7 +150852,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -154857,7 +151087,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -154894,7 +151123,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155006,7 +151234,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155030,7 +151257,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155065,7 +151291,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155088,7 +151313,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155131,7 +151355,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155174,7 +151397,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155233,7 +151455,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -155254,7 +151475,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155271,8 +151491,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155376,7 +151595,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -155412,7 +151630,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155471,7 +151688,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155502,7 +151718,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155553,7 +151768,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155570,14 +151784,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155614,7 +151826,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155690,7 +151901,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155727,7 +151937,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155750,7 +151959,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155799,7 +152007,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155853,14 +152060,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155941,7 +152146,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155958,7 +152162,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -155975,7 +152178,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156000,7 +152202,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156061,7 +152262,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156196,7 +152396,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156280,14 +152479,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156303,7 +152500,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156320,14 +152516,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156357,7 +152551,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156387,7 +152580,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156417,7 +152609,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156432,8 +152623,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156542,8 +152732,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156558,8 +152747,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156595,8 +152783,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -156604,7 +152791,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156655,7 +152841,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156671,7 +152856,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156687,7 +152871,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156703,7 +152886,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156733,7 +152915,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156756,7 +152937,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156772,7 +152952,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156849,7 +153028,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156865,7 +153043,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -156942,7 +153119,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157036,7 +153212,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157078,7 +153253,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157125,7 +153299,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -157160,7 +153333,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157175,8 +153347,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157219,10 +153390,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -157265,7 +153436,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157281,7 +153451,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157297,7 +153466,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157327,7 +153495,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157407,7 +153574,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157428,8 +153594,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157447,14 +153612,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -157690,8 +153853,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157731,31 +153893,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -157765,15 +153926,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -157836,7 +153996,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", "name": "ShippingOptionItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -157904,7 +154063,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", "name": "ShippingOptionItemRenderMode", "description": "The render mode of a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", @@ -157920,7 +154078,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158001,7 +154158,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158018,7 +154174,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158060,7 +154215,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158077,7 +154231,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158102,7 +154255,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158170,7 +154322,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -158240,14 +154391,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -158277,7 +154426,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -158324,7 +154472,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -158348,14 +154495,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -158371,7 +154516,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -158395,14 +154539,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -158468,7 +154610,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158545,7 +154686,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158561,7 +154701,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158604,14 +154743,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158641,7 +154778,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158671,7 +154807,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158701,7 +154836,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158778,7 +154912,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158872,7 +155005,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158896,7 +155028,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158938,7 +155069,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -158985,7 +155115,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -159020,7 +155149,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -159036,7 +155164,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159078,7 +155205,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159166,14 +155292,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159189,7 +155313,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159213,14 +155336,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159243,7 +155364,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159267,14 +155387,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159290,7 +155408,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159314,14 +155431,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159344,7 +155459,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159368,14 +155482,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159391,7 +155503,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159415,14 +155526,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159453,7 +155562,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -159490,7 +155598,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159514,14 +155621,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159537,7 +155642,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159561,14 +155665,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159584,7 +155686,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159608,14 +155709,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159631,7 +155730,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159654,7 +155752,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159677,7 +155774,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -159922,14 +156018,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159952,7 +156046,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159975,7 +156068,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -159999,7 +156091,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -160235,14 +156326,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160356,7 +156446,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160383,7 +156473,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160404,7 +156494,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160462,14 +156552,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160491,44 +156581,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160544,7 +156631,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160558,10 +156644,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -160605,7 +156691,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160635,7 +156720,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160677,7 +156761,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -160698,7 +156781,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160766,7 +156848,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160789,7 +156870,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160831,14 +156911,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160854,7 +156932,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160877,7 +156954,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160900,7 +156976,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160944,7 +157019,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -160979,7 +157053,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -161026,7 +157099,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161049,7 +157121,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -161285,7 +157356,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161322,7 +157392,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161434,7 +157503,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161458,7 +157526,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161493,7 +157560,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161516,7 +157582,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161559,7 +157624,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161602,7 +157666,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161661,7 +157724,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -161682,7 +157744,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161699,8 +157760,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161804,7 +157864,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -161840,7 +157899,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161899,7 +157957,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161930,7 +157987,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161981,7 +158037,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -161998,14 +158053,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162042,7 +158095,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162118,7 +158170,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162155,7 +158206,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162178,7 +158228,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162227,7 +158276,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162281,14 +158329,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162369,7 +158415,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162386,7 +158431,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162403,7 +158447,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162428,7 +158471,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162489,7 +158531,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162624,7 +158665,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162708,14 +158748,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162731,7 +158769,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162748,14 +158785,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162785,7 +158820,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162815,7 +158849,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162845,7 +158878,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162860,8 +158892,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162970,8 +159001,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -162986,8 +159016,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163023,8 +159052,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -163032,7 +159060,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163083,7 +159110,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163099,7 +159125,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163115,7 +159140,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163131,7 +159155,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163161,7 +159184,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163184,7 +159206,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163200,7 +159221,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163277,7 +159297,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163293,7 +159312,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163370,7 +159388,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163464,7 +159481,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163506,7 +159522,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163553,7 +159568,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -163588,7 +159602,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163603,8 +159616,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163647,10 +159659,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -163693,7 +159705,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163709,7 +159720,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163725,7 +159735,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163755,7 +159764,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163835,7 +159843,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163856,8 +159863,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -163875,14 +159881,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -164118,8 +160122,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -164159,31 +160162,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -164193,15 +160195,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -164264,7 +160265,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "ShippingOptionListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -164325,7 +160325,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "DeliverySelectionGroup", "description": "A named group of delivery options that the buyer can select as a unit.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -164376,7 +160375,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -164392,7 +160390,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -164434,7 +160431,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "DeliveryGroupList", "description": "A collection of delivery groups that share the same group type.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -164457,7 +160453,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -164511,14 +160506,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -164599,7 +160592,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -164616,7 +160608,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -164633,7 +160624,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -164658,7 +160648,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -164719,7 +160708,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -164854,7 +160842,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -165090,7 +161077,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -165174,14 +161160,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "CartLineReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -165204,7 +161188,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -165274,14 +161257,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -165311,7 +161292,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -165358,7 +161338,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -165382,14 +161361,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -165405,7 +161382,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -165429,14 +161405,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -165502,7 +161476,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -165579,7 +161552,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -165595,7 +161567,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -165638,14 +161609,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -165675,7 +161644,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -165705,7 +161673,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -165735,7 +161702,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -165812,7 +161778,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -165906,7 +161871,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -165930,7 +161894,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -165972,7 +161935,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -166019,7 +161981,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -166054,7 +162015,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -166070,7 +162030,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166112,7 +162071,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166200,14 +162158,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166223,7 +162179,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166247,14 +162202,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166277,7 +162230,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166301,14 +162253,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166324,7 +162274,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166348,14 +162297,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166378,7 +162325,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166402,14 +162348,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166425,7 +162369,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166449,14 +162392,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166487,7 +162428,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -166524,7 +162464,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166548,14 +162487,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166571,7 +162508,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166595,14 +162531,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166618,7 +162552,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166642,14 +162575,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166665,7 +162596,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166688,7 +162618,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166711,7 +162640,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -166956,14 +162884,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -166986,7 +162912,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -167009,7 +162934,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -167033,7 +162957,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -167269,14 +163192,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167390,7 +163312,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167417,7 +163339,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167438,7 +163360,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167496,14 +163418,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167525,44 +163447,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167578,7 +163497,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167592,10 +163510,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -167639,7 +163557,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167669,7 +163586,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167711,7 +163627,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -167732,7 +163647,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167800,7 +163714,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167823,7 +163736,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167865,14 +163777,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167888,7 +163798,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167911,7 +163820,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167934,7 +163842,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -167978,7 +163885,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168013,7 +163919,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -168060,7 +163965,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168083,7 +163987,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -168319,7 +164222,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168356,7 +164258,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168468,7 +164369,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168492,7 +164392,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168527,7 +164426,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168550,7 +164448,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168593,7 +164490,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168636,7 +164532,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168695,7 +164590,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -168716,7 +164610,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168733,8 +164626,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168838,7 +164730,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -168874,7 +164765,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168933,7 +164823,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -168964,7 +164853,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169015,7 +164903,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169032,14 +164919,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169076,7 +164961,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169152,7 +165036,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169189,7 +165072,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169212,7 +165094,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169261,7 +165142,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169315,14 +165195,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169403,7 +165281,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169420,7 +165297,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169437,7 +165313,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169462,7 +165337,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169523,7 +165397,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169658,7 +165531,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169742,14 +165614,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169765,7 +165635,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169782,14 +165651,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169819,7 +165686,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169849,7 +165715,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169879,7 +165744,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -169894,8 +165758,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170004,8 +165867,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170020,8 +165882,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170057,8 +165918,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -170066,7 +165926,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170117,7 +165976,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170133,7 +165991,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170149,7 +166006,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170165,7 +166021,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170195,7 +166050,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170218,7 +166072,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170234,7 +166087,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170311,7 +166163,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170327,7 +166178,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170404,7 +166254,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170498,7 +166347,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170540,7 +166388,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170587,7 +166434,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -170622,7 +166468,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170637,8 +166482,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170681,10 +166525,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -170727,7 +166571,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170743,7 +166586,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170759,7 +166601,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170789,7 +166630,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170869,7 +166709,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170890,8 +166729,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -170909,14 +166747,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -171152,8 +166988,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -171193,31 +167028,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -171227,15 +167061,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -171298,7 +167131,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "ShippingOptionListApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -171359,7 +167191,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "DeliverySelectionGroup", "description": "A named group of delivery options that the buyer can select as a unit.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -171410,7 +167241,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -171426,7 +167256,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -171468,7 +167297,6 @@ "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", "name": "DeliveryGroupList", "description": "A collection of delivery groups that share the same group type.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", @@ -171491,7 +167319,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -171545,14 +167372,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -171633,7 +167458,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -171650,7 +167474,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -171667,7 +167490,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -171692,7 +167514,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -171753,7 +167574,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -171888,7 +167708,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -172124,7 +167943,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -172208,14 +168026,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "CartLineReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -172238,7 +168054,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CheckoutApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -172308,14 +168123,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChange", "value": "AttributeUpdateChange | AttributeRemoveChange", - "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", - "isPublicDocs": true + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it." }, "AttributeUpdateChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeUpdateChange", "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -172345,7 +168158,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -172392,7 +168204,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeRemoveChange", "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -172416,14 +168227,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "AttributeChangeResult", "value": "AttributeChangeResultSuccess | AttributeChangeResultError", - "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "AttributeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultSuccess", "description": "The result of a successful attribute change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -172439,7 +168248,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "AttributeChangeResultError", "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -172463,14 +168271,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChange", "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", - "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", - "isPublicDocs": true + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes." }, "CartLineAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineAddChange", "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -172536,7 +168342,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -172613,7 +168418,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -172629,7 +168433,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -172672,14 +168475,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -172709,7 +168510,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -172739,7 +168539,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -172769,7 +168568,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -172846,7 +168644,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -172940,7 +168737,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -172964,7 +168760,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -173006,7 +168801,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -173053,7 +168847,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -173088,7 +168881,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -173104,7 +168896,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineRemoveChange", "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173146,7 +168937,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineUpdateChange", "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173234,14 +169024,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartLineChangeResult", "value": "CartLineChangeResultSuccess | CartLineChangeResultError", - "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "CartLineChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultSuccess", "description": "The result of a successful cart line change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173257,7 +169045,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "CartLineChangeResultError", "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173281,14 +169068,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChange", "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", - "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it." }, "DiscountCodeAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeAddChange", "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173311,7 +169096,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeRemoveChange", "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173335,14 +169119,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DiscountCodeChangeResult", "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", - "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "DiscountCodeChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultSuccess", "description": "The result of a successful discount code change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173358,7 +169140,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "DiscountCodeChangeResultError", "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173382,14 +169163,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChange", "value": "GiftCardAddChange | GiftCardRemoveChange", - "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", - "isPublicDocs": true + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it." }, "GiftCardAddChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardAddChange", "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173412,7 +169191,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardRemoveChange", "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173436,14 +169214,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "GiftCardChangeResult", "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", - "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "GiftCardChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultSuccess", "description": "The result of a successful gift card change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173459,7 +169235,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "GiftCardChangeResultError", "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173483,14 +169258,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChange", "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", - "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", - "isPublicDocs": true + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield." }, "MetafieldRemoveCartChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldRemoveCartChange", "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173521,7 +169294,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartMetafield", "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -173558,7 +169330,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldUpdateCartChange", "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173582,14 +169353,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "MetafieldChangeResult", "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", - "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "MetafieldChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultSuccess", "description": "The result of a successful metafield change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173605,7 +169374,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "MetafieldChangeResultError", "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173629,14 +169397,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChange", "value": "NoteRemoveChange | NoteUpdateChange", - "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", - "isPublicDocs": true + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it." }, "NoteRemoveChange": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteRemoveChange", "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173652,7 +169418,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteUpdateChange", "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173676,14 +169441,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "NoteChangeResult", "value": "NoteChangeResultSuccess | NoteChangeResultError", - "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", - "isPublicDocs": true + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed." }, "NoteChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultSuccess", "description": "The result of a successful note change. The `type` property is `'success'`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173699,7 +169462,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "NoteChangeResultError", "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173722,7 +169484,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressUpdateChange", "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -173745,7 +169506,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -173990,14 +169750,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ShippingAddressChangeResult", "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", - "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", - "isPublicDocs": true + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details." }, "ShippingAddressChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultSuccess", "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -174020,7 +169778,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeResultError", "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -174043,7 +169800,6 @@ "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", "name": "ShippingAddressChangeFieldError", "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", @@ -174067,7 +169823,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -174303,14 +170058,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174424,7 +170178,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174451,7 +170205,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174472,7 +170226,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174530,14 +170284,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174559,44 +170313,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174612,7 +170363,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174626,10 +170376,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -174673,7 +170423,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174703,7 +170452,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174745,7 +170493,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -174766,7 +170513,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174834,7 +170580,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174857,7 +170602,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174899,14 +170643,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174922,7 +170664,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174945,7 +170686,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -174968,7 +170708,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175012,7 +170751,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175047,7 +170785,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -175094,7 +170831,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175117,7 +170853,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -175353,7 +171088,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175390,7 +171124,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175502,7 +171235,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175526,7 +171258,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175561,7 +171292,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175584,7 +171314,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175627,7 +171356,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175670,7 +171398,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175729,7 +171456,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -175750,7 +171476,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175767,8 +171492,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175872,7 +171596,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -175908,7 +171631,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175967,7 +171689,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -175998,7 +171719,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176049,7 +171769,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176066,14 +171785,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176110,7 +171827,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176186,7 +171902,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176223,7 +171938,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176246,7 +171960,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176295,7 +172008,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176349,14 +172061,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176437,7 +172147,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176454,7 +172163,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176471,7 +172179,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176496,7 +172203,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176557,7 +172263,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176692,7 +172397,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176776,14 +172480,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176799,7 +172501,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176816,14 +172517,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176853,7 +172552,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176883,7 +172581,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176913,7 +172610,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -176928,8 +172624,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177038,8 +172733,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177054,8 +172748,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177091,8 +172784,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -177100,7 +172792,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177151,7 +172842,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177167,7 +172857,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177183,7 +172872,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177199,7 +172887,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177229,7 +172916,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177252,7 +172938,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177268,7 +172953,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177345,7 +173029,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177361,7 +173044,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177438,7 +173120,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177532,7 +173213,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177574,7 +173254,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177621,7 +173300,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -177656,7 +173334,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177671,8 +173348,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177715,10 +173391,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -177761,7 +173437,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177777,7 +173452,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177793,7 +173467,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177823,7 +173496,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177903,7 +173575,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177924,8 +173595,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -177943,14 +173613,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -178186,8 +173854,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178227,31 +173894,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178261,15 +173927,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -178332,7 +173997,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmationApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -178386,7 +174050,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -178424,14 +174087,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178545,7 +174207,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178572,7 +174234,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178593,7 +174255,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178651,14 +174313,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178680,44 +174342,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178733,7 +174392,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178747,10 +174405,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -178794,7 +174452,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178824,7 +174481,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178866,7 +174522,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -178887,7 +174542,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178955,7 +174609,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -178978,7 +174631,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179020,14 +174672,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179043,7 +174693,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179066,7 +174715,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179089,7 +174737,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179133,7 +174780,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179168,7 +174814,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -179215,7 +174860,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179238,7 +174882,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -179474,7 +175117,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179511,7 +175153,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179623,7 +175264,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179647,7 +175287,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179682,7 +175321,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179705,7 +175343,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179748,7 +175385,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179791,7 +175427,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179850,7 +175485,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -179871,7 +175505,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179888,8 +175521,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -179993,7 +175625,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -180029,7 +175660,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180088,7 +175718,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180119,7 +175748,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180170,7 +175798,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180187,14 +175814,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180231,7 +175856,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180307,7 +175931,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180344,7 +175967,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180367,7 +175989,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180416,7 +176037,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180470,14 +176090,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180558,7 +176176,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180575,7 +176192,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180592,7 +176208,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180617,7 +176232,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180678,7 +176292,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180813,7 +176426,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180897,14 +176509,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180920,7 +176530,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180937,14 +176546,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -180974,7 +176581,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181004,7 +176610,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181034,7 +176639,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181049,8 +176653,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181159,8 +176762,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181175,8 +176777,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181212,8 +176813,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -181221,7 +176821,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181272,7 +176871,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181288,7 +176886,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181304,7 +176901,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181320,7 +176916,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181350,7 +176945,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181373,7 +176967,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181389,7 +176982,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181466,7 +177058,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181482,7 +177073,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181559,7 +177149,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181653,7 +177242,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181695,7 +177283,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181742,7 +177329,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -181777,7 +177363,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181792,8 +177377,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181836,10 +177420,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -181882,7 +177466,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181898,7 +177481,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181914,7 +177496,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -181944,7 +177525,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182024,7 +177604,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182045,8 +177624,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182064,14 +177642,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -182307,8 +177883,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182348,31 +177923,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182382,15 +177956,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -182453,7 +178026,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmationApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -182507,7 +178079,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -182545,14 +178116,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182666,7 +178236,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182693,7 +178263,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182714,7 +178284,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182772,14 +178342,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182801,44 +178371,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182854,7 +178421,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182868,10 +178434,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -182915,7 +178481,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182945,7 +178510,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -182987,7 +178551,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -183008,7 +178571,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183076,7 +178638,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183099,7 +178660,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183141,14 +178701,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183164,7 +178722,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183187,7 +178744,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183210,7 +178766,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183254,7 +178809,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183289,7 +178843,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -183336,7 +178889,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183359,7 +178911,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -183595,7 +179146,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183632,7 +179182,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183744,7 +179293,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183768,7 +179316,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183803,7 +179350,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183826,7 +179372,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183869,7 +179414,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183912,7 +179456,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -183971,7 +179514,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -183992,7 +179534,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184009,8 +179550,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184114,7 +179654,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -184150,7 +179689,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184209,7 +179747,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184240,7 +179777,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184291,7 +179827,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184308,14 +179843,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184352,7 +179885,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184428,7 +179960,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184465,7 +179996,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184488,7 +180018,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184537,7 +180066,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184591,14 +180119,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184679,7 +180205,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184696,7 +180221,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184713,7 +180237,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184738,7 +180261,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184799,7 +180321,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -184934,7 +180455,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185018,14 +180538,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185041,7 +180559,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185058,14 +180575,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185095,7 +180610,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185125,7 +180639,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185155,7 +180668,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185170,8 +180682,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185280,8 +180791,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185296,8 +180806,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185333,8 +180842,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -185342,7 +180850,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185393,7 +180900,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185409,7 +180915,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185425,7 +180930,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185441,7 +180945,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185471,7 +180974,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185494,7 +180996,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185510,7 +181011,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185587,7 +181087,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185603,7 +181102,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185680,7 +181178,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185774,7 +181271,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185816,7 +181312,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185863,7 +181358,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -185898,7 +181392,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185913,8 +181406,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -185957,10 +181449,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -186003,7 +181495,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186019,7 +181510,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186035,7 +181525,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186065,7 +181554,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186145,7 +181633,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186166,8 +181653,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186185,14 +181671,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -186428,8 +181912,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186469,31 +181952,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186503,15 +181985,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -186574,7 +182055,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmationApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -186628,7 +182108,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -186666,7 +182145,6 @@ "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", "name": "CartLineItemApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", @@ -186720,7 +182198,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186797,7 +182274,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -186844,7 +182320,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186860,7 +182335,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186903,14 +182377,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186940,7 +182412,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -186970,7 +182441,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187000,7 +182470,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187077,7 +182546,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187171,7 +182639,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187195,7 +182662,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187237,7 +182703,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187284,7 +182749,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -187319,7 +182783,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187342,14 +182805,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187463,7 +182925,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187490,7 +182952,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187511,7 +182973,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187569,14 +183031,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187598,44 +183060,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187651,7 +183110,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187665,10 +183123,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -187712,7 +183170,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187742,7 +183199,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187784,7 +183240,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -187805,7 +183260,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187873,7 +183327,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187896,7 +183349,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187938,14 +183390,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187961,7 +183411,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -187984,7 +183433,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188007,7 +183455,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188051,7 +183498,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188086,7 +183532,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -188133,7 +183578,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188156,7 +183600,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -188392,7 +183835,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188429,7 +183871,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188541,7 +183982,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188565,7 +184005,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188600,7 +184039,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188623,7 +184061,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188666,7 +184103,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188709,7 +184145,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188768,7 +184203,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -188789,7 +184223,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188806,8 +184239,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -188911,7 +184343,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -188947,7 +184378,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189006,7 +184436,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189037,7 +184466,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189088,7 +184516,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189105,14 +184532,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189149,7 +184574,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189225,7 +184649,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189262,7 +184685,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189285,7 +184707,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189334,7 +184755,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189388,14 +184808,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189476,7 +184894,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189493,7 +184910,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189510,7 +184926,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189535,7 +184950,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189596,7 +185010,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189731,7 +185144,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189815,14 +185227,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189838,7 +185248,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189855,14 +185264,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189892,7 +185299,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189922,7 +185328,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189952,7 +185357,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -189967,8 +185371,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190077,8 +185480,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190093,8 +185495,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190130,8 +185531,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -190139,7 +185539,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190190,7 +185589,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190206,7 +185604,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190222,7 +185619,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190238,7 +185634,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190268,7 +185663,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190291,7 +185685,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190307,7 +185700,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190384,7 +185776,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190400,7 +185791,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190477,7 +185867,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190571,7 +185960,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190613,7 +186001,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190660,7 +186047,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -190695,7 +186081,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190710,8 +186095,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190754,10 +186138,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -190800,7 +186184,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190816,7 +186199,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190832,7 +186214,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190862,7 +186243,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190942,7 +186322,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190963,8 +186342,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -190982,14 +186360,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -191225,8 +186601,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191266,31 +186641,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191300,15 +186674,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -191371,7 +186744,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmationApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -191425,7 +186797,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -191463,14 +186834,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191584,7 +186954,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191611,7 +186981,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191632,7 +187002,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191690,14 +187060,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191719,44 +187089,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191772,7 +187139,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191786,10 +187152,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -191833,7 +187199,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191863,7 +187228,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191905,7 +187269,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -191926,7 +187289,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -191994,7 +187356,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192017,7 +187378,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192059,14 +187419,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192082,7 +187440,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192105,7 +187462,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192128,7 +187484,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192172,7 +187527,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192207,7 +187561,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -192254,7 +187607,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192277,7 +187629,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -192513,7 +187864,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192550,7 +187900,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192662,7 +188011,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192686,7 +188034,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192721,7 +188068,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192744,7 +188090,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192787,7 +188132,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192830,7 +188174,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192889,7 +188232,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -192910,7 +188252,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -192927,8 +188268,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193032,7 +188372,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -193068,7 +188407,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193127,7 +188465,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193158,7 +188495,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193209,7 +188545,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193226,14 +188561,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193270,7 +188603,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193346,7 +188678,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193383,7 +188714,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193406,7 +188736,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193455,7 +188784,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193509,14 +188837,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193597,7 +188923,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193614,7 +188939,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193631,7 +188955,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193656,7 +188979,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193717,7 +189039,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193852,7 +189173,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193936,14 +189256,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193959,7 +189277,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -193976,14 +189293,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194013,7 +189328,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194043,7 +189357,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194073,7 +189386,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194088,8 +189400,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194198,8 +189509,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194214,8 +189524,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194251,8 +189560,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -194260,7 +189568,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194311,7 +189618,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194327,7 +189633,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194343,7 +189648,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194359,7 +189663,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194389,7 +189692,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194412,7 +189714,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194428,7 +189729,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194505,7 +189805,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194521,7 +189820,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194598,7 +189896,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194692,7 +189989,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194734,7 +190030,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194781,7 +190076,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -194816,7 +190110,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194831,8 +190124,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194875,10 +190167,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -194921,7 +190213,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194937,7 +190228,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194953,7 +190243,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -194983,7 +190272,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195063,7 +190351,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195084,8 +190371,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195103,14 +190389,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -195346,8 +190630,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195387,31 +190670,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195421,15 +190703,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -195492,7 +190773,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmationApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -195546,7 +190826,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -195584,14 +190863,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195705,7 +190983,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195732,7 +191010,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195753,7 +191031,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195811,14 +191089,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195840,44 +191118,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195893,7 +191168,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195907,10 +191181,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -195954,7 +191228,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -195984,7 +191257,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196026,7 +191298,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -196047,7 +191318,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196115,7 +191385,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196138,7 +191407,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196180,14 +191448,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196203,7 +191469,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196226,7 +191491,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196249,7 +191513,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196293,7 +191556,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196328,7 +191590,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -196375,7 +191636,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196398,7 +191658,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -196634,7 +191893,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196671,7 +191929,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196783,7 +192040,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196807,7 +192063,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196842,7 +192097,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196865,7 +192119,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196908,7 +192161,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -196951,7 +192203,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197010,7 +192261,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -197031,7 +192281,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197048,8 +192297,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197153,7 +192401,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -197189,7 +192436,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197248,7 +192494,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197279,7 +192524,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197330,7 +192574,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197347,14 +192590,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197391,7 +192632,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197467,7 +192707,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197504,7 +192743,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197527,7 +192765,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197576,7 +192813,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197630,14 +192866,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197718,7 +192952,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197735,7 +192968,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197752,7 +192984,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197777,7 +193008,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197838,7 +193068,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -197973,7 +193202,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198057,14 +193285,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198080,7 +193306,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198097,14 +193322,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198134,7 +193357,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198164,7 +193386,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198194,7 +193415,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198209,8 +193429,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198319,8 +193538,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198335,8 +193553,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198372,8 +193589,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -198381,7 +193597,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198432,7 +193647,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198448,7 +193662,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198464,7 +193677,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198480,7 +193692,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198510,7 +193721,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198533,7 +193743,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198549,7 +193758,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198626,7 +193834,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198642,7 +193849,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198719,7 +193925,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198813,7 +194018,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198855,7 +194059,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198902,7 +194105,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -198937,7 +194139,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198952,8 +194153,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -198996,10 +194196,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -199042,7 +194242,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199058,7 +194257,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199074,7 +194272,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199104,7 +194301,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199184,7 +194380,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199205,8 +194400,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199224,14 +194418,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -199467,8 +194659,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199508,31 +194699,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199542,15 +194732,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -199613,7 +194802,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmationApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -199667,7 +194855,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -199705,14 +194892,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199826,7 +195012,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199853,7 +195039,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199874,7 +195060,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199932,14 +195118,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -199961,44 +195147,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200014,7 +195197,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200028,10 +195210,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -200075,7 +195257,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200105,7 +195286,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200147,7 +195327,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -200168,7 +195347,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200236,7 +195414,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200259,7 +195436,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200301,14 +195477,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200324,7 +195498,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200347,7 +195520,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200370,7 +195542,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200414,7 +195585,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200449,7 +195619,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -200496,7 +195665,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200519,7 +195687,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -200755,7 +195922,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200792,7 +195958,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200904,7 +196069,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200928,7 +196092,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200963,7 +196126,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -200986,7 +196148,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201029,7 +196190,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201072,7 +196232,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201131,7 +196290,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -201152,7 +196310,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201169,8 +196326,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201274,7 +196430,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -201310,7 +196465,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201369,7 +196523,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201400,7 +196553,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201451,7 +196603,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201468,14 +196619,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201512,7 +196661,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201588,7 +196736,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201625,7 +196772,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201648,7 +196794,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201697,7 +196842,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201751,14 +196895,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201839,7 +196981,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201856,7 +196997,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201873,7 +197013,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201898,7 +197037,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -201959,7 +197097,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202094,7 +197231,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202178,14 +197314,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202201,7 +197335,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202218,14 +197351,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202255,7 +197386,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202285,7 +197415,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202315,7 +197444,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202330,8 +197458,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202440,8 +197567,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202456,8 +197582,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202493,8 +197618,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -202502,7 +197626,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202553,7 +197676,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202569,7 +197691,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202585,7 +197706,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202601,7 +197721,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202631,7 +197750,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202654,7 +197772,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202670,7 +197787,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202747,7 +197863,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202763,7 +197878,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202840,7 +197954,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202934,7 +198047,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -202976,7 +198088,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203023,7 +198134,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -203058,7 +198168,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203073,8 +198182,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203117,10 +198225,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -203163,7 +198271,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203179,7 +198286,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203195,7 +198301,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203225,7 +198330,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203305,7 +198409,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203326,8 +198429,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203345,14 +198447,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -203588,8 +198688,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203629,31 +198728,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203663,15 +198761,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -203734,7 +198831,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmationApi", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -203788,7 +198884,6 @@ "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", "name": "OrderConfirmation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", @@ -203826,14 +198921,13 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StandardApi", "description": "", - "isPublicDocs": true, "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." + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203947,7 +199041,7 @@ "syntaxKind": "PropertySignature", "name": "extension", "value": "Extension", - "description": "The meta information about the extension." + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203974,7 +199068,7 @@ "syntaxKind": "PropertySignature", "name": "i18n", "value": "I18n", - "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) of the checkout.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples) for more information." + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -203995,7 +199089,7 @@ "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/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-i18n) object instead." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204053,14 +199147,14 @@ "syntaxKind": "PropertySignature", "name": "shop", "value": "Shop", - "description": "The shop where the checkout is taking place." + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." }, { "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." + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated extension targets of this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204082,44 +199176,41 @@ ] } ], - "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 * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\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 is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/apis/localization)\n * of the checkout.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\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/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 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 * 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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\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 before performing any actions that might 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 aren't available.\n * See the [update guide](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/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}]` isn't 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 key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\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 and lets you intercept navigation to validate data before the buyer continues.\n *\n * Refer to [buyer journey](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\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 * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/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 strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\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/{API_VERSION}/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 payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\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 five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Refer to [session token examples](/docs/api/checkout-ui-extensions/{API_VERSION}/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/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates 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 * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\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. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided 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 billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated extension targets of this\n * extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\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 * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`customer_privacy` capability](/docs/api/checkout-ui-extensions/{API_VERSION}/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 * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" }, "Analytics": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Analytics", - "description": "", - "isPublicDocs": true, + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", "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)." + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched." }, { "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." + "description": "Submits buyer contact details for attribution and analytics purposes." } ], - "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}" + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\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.", - "isPublicDocs": true + "description": "Represents a visitor result." }, "VisitorSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorSuccess", "description": "Represents a successful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204135,7 +199226,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorError", "description": "Represents an unsuccessful visitor result.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204149,10 +199239,10 @@ "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." + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting 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 isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" }, "SubscribableSignalLike": { "filePath": "src/surfaces/checkout/shared.ts", @@ -204196,7 +199286,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppliedGiftCard", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204226,7 +199315,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Money", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204268,7 +199356,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ApplyTrackingConsentChangeType", "description": "", - "isPublicDocs": true, "params": [ { "name": "visitorConsent", @@ -204289,7 +199376,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsentChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204357,7 +199443,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafieldChange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204380,7 +199465,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "VisitorConsent", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204422,14 +199506,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "TrackingConsentChangeResult", "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", - "description": "", - "isPublicDocs": true + "description": "" }, "TrackingConsentChangeResultSuccess": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentChangeResultSuccess", "description": "The returned result of a successful tracking consent preference update.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204445,7 +199527,6 @@ "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.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204468,7 +199549,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntry", "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204491,7 +199571,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafield", "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204535,7 +199614,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AppMetafieldEntryTarget", "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204570,7 +199648,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "Attribute", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -204617,7 +199694,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentOption", "description": "A payment option presented to the buyer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204640,7 +199716,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "MailingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -204876,7 +199951,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerIdentity", "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -204913,7 +199987,6 @@ "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).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205025,7 +200098,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ImageDetails", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205049,7 +200121,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "StoreCreditAccount", "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205084,7 +200155,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PurchasingCompany", "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205107,7 +200177,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Company", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205150,7 +200219,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CompanyLocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205193,7 +200261,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourney", "description": "Provides details on the buyer's progression through the checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205252,7 +200319,6 @@ "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: 'your reason here', errors?: ValidationError[]}`. 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.", - "isPublicDocs": true, "params": [ { "name": "interceptorProps", @@ -205273,7 +200339,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "InterceptorProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205290,8 +200355,7 @@ "syntaxKind": "TypeAliasDeclaration", "name": "InterceptorRequest", "value": "InterceptorRequestAllow | InterceptorRequestBlock", - "description": "", - "isPublicDocs": true + "description": "" }, "InterceptorRequestAllow": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205395,7 +200459,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ValidationError", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -205431,7 +200494,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "BuyerJourneyStep", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205490,7 +200552,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CheckoutSettings", "description": "Settings describing the behavior of the buyer's checkout.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205521,7 +200582,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PaymentTermsTemplate", "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205572,7 +200632,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingAddressSettings", "description": "Settings describing the behavior of the shipping address.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205589,14 +200648,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CheckoutToken", "value": "string", - "description": "", - "isPublicDocs": true + "description": "" }, "CartCost": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205633,7 +200690,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacy", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205709,7 +200765,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AllowedProcessing", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205746,7 +200801,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "TrackingConsentMetafield", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205769,7 +200823,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CustomerPrivacyRegion", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205818,7 +200871,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryGroup", "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205872,14 +200924,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryOption", "value": "ShippingOption | PickupPointOption | PickupLocationOption", - "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", - "isPublicDocs": true + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse." }, "ShippingOption": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOption", "description": "Represents a delivery option that's a shipping option.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205960,7 +201010,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "ShippingOptionCarrier", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205977,7 +201026,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryEstimate", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -205994,7 +201042,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NumberRange", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206019,7 +201066,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Metafield", "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206080,7 +201126,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupPointOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206215,7 +201260,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "PickupLocationOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206299,14 +201343,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "DeliveryGroupType", "value": "'oneTimePurchase' | 'subscription'", - "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", - "isPublicDocs": true + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." }, "DeliveryOptionReference": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryOptionReference", "description": "A reference to the delivery option selected by the buyer for a delivery group.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206322,7 +201364,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineReference", "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206339,14 +201380,12 @@ "syntaxKind": "TypeAliasDeclaration", "name": "CartDiscountAllocation", "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", - "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", - "isPublicDocs": true + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount)." }, "CartCodeDiscountAllocation": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCodeDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206376,7 +201415,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartAutomaticDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206406,7 +201444,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartCustomDiscountAllocation", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206436,7 +201473,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartDiscountCode", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206451,8 +201487,7 @@ "Extension": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Extension", - "description": "The meta information about an extension target.", - "isPublicDocs": true, + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206561,8 +201596,7 @@ "Editor": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Editor", - "description": "", - "isPublicDocs": true, + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206577,8 +201611,7 @@ "I18n": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18n", - "description": "", - "isPublicDocs": true, + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206614,8 +201647,7 @@ "I18nTranslate": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "I18nTranslate", - "description": "This returns a translated string matching a key in a locale file.", - "isPublicDocs": true, + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", "members": [], "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" }, @@ -206623,7 +201655,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206674,7 +201705,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "AttributesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206690,7 +201720,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DeliveryCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206706,7 +201735,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "DiscountsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206722,7 +201750,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLinesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206752,7 +201779,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "MetafieldsCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206775,7 +201801,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "NotesCartInstructions", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206791,7 +201816,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLine", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206868,7 +201892,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineCost", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206884,7 +201907,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartBundleLineComponent", "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -206961,7 +201983,6 @@ "name": "Merchandise", "value": "ProductVariant", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207055,7 +202076,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Product", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207097,7 +202117,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SelectedOption", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207144,7 +202163,6 @@ "filePath": "src/surfaces/checkout/api/shared.ts", "name": "SellingPlan", "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -207179,7 +202197,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "CartLineParentRelationship", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207194,8 +202211,7 @@ "Localization": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Localization", - "description": "", - "isPublicDocs": true, + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207238,10 +202254,10 @@ "syntaxKind": "PropertySignature", "name": "timezone", "value": "SubscribableSignalLike", - "description": "The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." } ], - "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, derived from their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. It updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.\n *\n * > Caution: Deprecated as of version `2025-04`. Merchants now manage which extensions load for each market, so extensions no longer need to check this value.\n *\n * @deprecated Deprecated as of version `2025-04`\n */\n market: SubscribableSignalLike;\n}" }, "Country": { "filePath": "src/shared.ts", @@ -207284,7 +202300,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Currency", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207300,7 +202315,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Language", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207316,7 +202330,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Market", "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207346,7 +202359,6 @@ "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "LocalizedField", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207426,7 +202438,6 @@ "name": "SelectedPaymentOption", "value": "PaymentOption", "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207447,8 +202458,7 @@ "SessionToken": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "SessionToken", - "description": "", - "isPublicDocs": true, + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207466,14 +202476,12 @@ "name": "ExtensionSettings", "value": "Record<\n string,\n string | number | boolean | undefined\n>", "description": "The merchant-defined setting values for the extension.", - "isPublicDocs": true, "members": [] }, "ShippingAddress": { "filePath": "src/surfaces/checkout/api/shared.ts", "name": "ShippingAddress", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/api/shared.ts", @@ -207709,8 +202717,7 @@ "Shop": { "filePath": "src/surfaces/checkout/api/standard/standard.ts", "name": "Shop", - "description": "", - "isPublicDocs": true, + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", "members": [ { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207750,31 +202757,30 @@ "syntaxKind": "PropertySignature", "name": "storefrontUrl", "value": "string", - "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n\n> Caution: > As of version `2024-04` this value no longer has a trailing slash.", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", "isOptional": true } ], - "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n *\n * > Caution:\n * > As of version `2024-04` this value no longer has a trailing slash.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom 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 available only 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.", - "isPublicDocs": true, + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and 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." + "description": "Deletes a previously stored value 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." + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns `null` if no stored data exists." }, { "filePath": "src/surfaces/checkout/api/standard/standard.ts", @@ -207784,15 +202790,14 @@ "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}" + "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 type.\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 * Deletes a previously stored value 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": "", - "isPublicDocs": true + "description": "" } } } @@ -207822,14 +202827,13 @@ "filePath": "src/surfaces/checkout/components/Abbreviation.ts", "name": "AbbreviationElementProps", "description": "The element props interface for the Abbreviation component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Abbreviation.ts", "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -207881,7 +202885,6 @@ "filePath": "src/surfaces/checkout/components/Announcement.ts", "name": "AnnouncementElementEvents", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -207966,7 +202969,6 @@ "filePath": "src/surfaces/checkout/components/Announcement.ts", "name": "AnnouncementElementMethods", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Announcement.ts", @@ -208022,7 +203024,6 @@ "filePath": "src/surfaces/checkout/components/Badge.ts", "name": "BadgeElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Badge.ts", @@ -208055,7 +203056,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -208084,8 +203085,7 @@ "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": "The subset of icon types available in checkout and customer account surfaces. This is a narrowed set from the full Shopify icon library, containing only the icons supported in these contexts.", - "isPublicDocs": true + "description": "The subset of icon types available in checkout and customer account surfaces. This is a narrowed set from the full Shopify icon library, containing only the icons supported in these contexts." } } } @@ -208124,7 +203124,6 @@ "filePath": "src/surfaces/checkout/components/Banner.ts", "name": "BannerElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Banner.ts", @@ -208167,7 +203166,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -208193,7 +203192,6 @@ "filePath": "src/surfaces/checkout/components/Banner.ts", "name": "BannerElementEvents", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Banner.ts", @@ -208272,7 +203270,6 @@ "filePath": "src/surfaces/checkout/components/Box.ts", "name": "BoxElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Box.ts", @@ -208380,7 +203377,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -208665,7 +203662,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -208860,7 +203857,6 @@ "filePath": "src/surfaces/checkout/components/Button.ts", "name": "ButtonElementProps", "description": "Configure the following properties on the button component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Button.ts", @@ -208909,7 +203905,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -208988,7 +203984,6 @@ "filePath": "src/surfaces/checkout/components/Button.ts", "name": "ButtonElementEvents", "description": "The button component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Button.ts", @@ -209058,8 +204053,7 @@ "CheckboxElementProps": { "filePath": "src/surfaces/checkout/components/Checkbox.ts", "name": "CheckboxElementProps", - "description": "The element props interface for the Checkbox component.", - "isPublicDocs": true, + "description": "Configure the following properties on the checkbox component.", "members": [ { "filePath": "src/surfaces/checkout/components/Checkbox.ts", @@ -209074,7 +204068,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -209100,7 +204094,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -209109,7 +204103,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -209118,7 +204112,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -209126,7 +204120,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -209134,7 +204128,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -209142,7 +204136,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -209175,19 +204169,18 @@ "CheckboxElementEvents": { "filePath": "src/surfaces/checkout/components/Checkbox.ts", "name": "CheckboxElementEvents", - "description": "The events interface for the Checkbox component.", - "isPublicDocs": true, + "description": "The checkbox component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "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.", + "description": "A callback fired when the checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "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}" + "value": "export interface CheckboxElementEvents {\n /**\n * A callback fired when the checkbox value changes.\n *\n * Learn more about the [change event](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", @@ -209239,8 +204232,7 @@ "ChipElementProps": { "filePath": "src/surfaces/checkout/components/Chip.ts", "name": "ChipElementProps", - "description": "The element props interface for the Chip component.", - "isPublicDocs": true, + "description": "Configure the following properties on the chip component.", "members": [ { "filePath": "src/surfaces/checkout/components/Chip.ts", @@ -209255,7 +204247,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -209271,8 +204263,7 @@ "ChipElementSlots": { "filePath": "src/surfaces/checkout/components/Chip.ts", "name": "ChipElementSlots", - "description": "The slots interface for the Chip component.", - "isPublicDocs": true, + "description": "The chip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", "members": [ { "filePath": "src/surfaces/checkout/components/Chip.ts", @@ -209321,15 +204312,14 @@ "ChoiceListElementProps": { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", "name": "ChoiceListElementProps", - "description": "The element props interface for the ChoiceList component.", - "isPublicDocs": true, + "description": "Configure the following properties on the choice list component.", "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.", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", "isOptional": true, "defaultValue": "false" }, @@ -209338,7 +204328,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -209346,7 +204336,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -209354,7 +204344,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -209362,7 +204352,7 @@ "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.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -209380,7 +204370,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -209413,19 +204403,18 @@ "ChoiceListElementEvents": { "filePath": "src/surfaces/checkout/components/ChoiceList.ts", "name": "ChoiceListElementEvents", - "description": "The events interface for the ChoiceList component.", - "isPublicDocs": true, + "description": "The choice list component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "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.", + "description": "A callback fired when the choice list value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "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}" + "value": "export interface ChoiceListElementEvents {\n /**\n * A callback fired when the choice list value changes.\n *\n * Learn more about the [change event](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", @@ -209451,8 +204440,7 @@ "ChoiceElementProps": { "filePath": "src/surfaces/checkout/components/Choice.ts", "name": "ChoiceElementProps", - "description": "The element props interface for the Choice component.", - "isPublicDocs": true, + "description": "Configure the following properties on the choice component.", "members": [ { "filePath": "src/surfaces/checkout/components/Choice.ts", @@ -209467,7 +204455,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -209476,7 +204464,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -209485,7 +204473,7 @@ "syntaxKind": "PropertySignature", "name": "error", "value": "boolean", - "description": "Set to `true` to associate a choice with the error passed to `ChoiceList`", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", "isOptional": true, "defaultValue": "false" }, @@ -209494,7 +204482,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -209502,7 +204490,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -209527,8 +204515,7 @@ "ChoiceElementSlots": { "filePath": "src/surfaces/checkout/components/Choice.ts", "name": "ChoiceElementSlots", - "description": "The slots interface for the Choice component.", - "isPublicDocs": true, + "description": "The choice component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", "members": [ { "filePath": "src/surfaces/checkout/components/Choice.ts", @@ -209651,7 +204638,6 @@ "filePath": "src/surfaces/checkout/components/Clickable.ts", "name": "ClickableElementProps", "description": "Configure the following properties on the clickable component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Clickable.ts", @@ -209784,7 +204770,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -210129,7 +205115,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -210359,7 +205345,6 @@ "filePath": "src/surfaces/checkout/components/Clickable.ts", "name": "ClickableElementEvents", "description": "The clickable component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Clickable.ts", @@ -210439,7 +205424,6 @@ "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementProps", "description": "Configure the following properties on the clickable chip component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -210480,7 +205464,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -210506,7 +205490,6 @@ "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementEvents", "description": "The clickable chip component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -210560,7 +205543,6 @@ "filePath": "src/surfaces/checkout/components/ClickableChip.ts", "name": "ClickableChipElementSlots", "description": "The clickable chip component supports slots for additional content placement. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/ClickableChip.ts", @@ -210610,14 +205592,13 @@ "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", "name": "ClipboardItemElementProps", "description": "Configure the following properties on the clipboard item component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -210643,7 +205624,6 @@ "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", "name": "ClipboardItemElementEvents", "description": "The clipboard item component provides event callbacks for handling copy interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", @@ -210714,8 +205694,7 @@ "ConsentCheckboxElementProps": { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "name": "ConsentCheckboxElementProps", - "description": "The element props interface for the ConsentCheckbox component.", - "isPublicDocs": true, + "description": "Configure the following properties on the consent checkbox component.", "members": [ { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", @@ -210730,7 +205709,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -210756,7 +205735,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -210765,7 +205744,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -210774,7 +205753,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -210782,7 +205761,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -210790,7 +205769,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -210798,7 +205777,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -210806,7 +205785,7 @@ "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.", + "description": "The policy for which user consent is being collected.", "isOptional": true }, { @@ -210837,19 +205816,18 @@ "ConsentCheckboxElementEvents": { "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", "name": "ConsentCheckboxElementEvents", - "description": "The events interface for the ConsentCheckbox component.", - "isPublicDocs": true, + "description": "The consent checkbox component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "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.", + "description": "A callback fired when the consent checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "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}" + "value": "export interface ConsentCheckboxElementEvents {\n /**\n * A callback fired when the consent checkbox value changes.\n *\n * Learn more about the [change event](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", @@ -210901,24 +205879,23 @@ "ConsentPhoneFieldElementProps": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementProps", - "description": "The element props interface for the ConsentPhoneField component.", - "isPublicDocs": true, + "description": "Configure the following properties on the consent phone field component.", "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.", + "description": "A hint about the intended content of the field for browser autofill.\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.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", "isOptional": true, - "defaultValue": "'on' for everything else" + "defaultValue": "'on'" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -210926,7 +205903,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -210935,7 +205912,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -210943,7 +205920,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -210951,7 +205928,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -210959,7 +205936,7 @@ "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.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -210968,7 +205945,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -210986,7 +205963,7 @@ "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.", + "description": "The policy for which user consent is being collected.", "isOptional": true }, { @@ -210994,7 +205971,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -211058,15 +206035,14 @@ "ConsentPhoneFieldElementEvents": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementEvents", - "description": "The events interface for the ConsentPhoneField component.", - "isPublicDocs": true, + "description": "The consent phone field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "members": [ { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the consent phone field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -211074,7 +206050,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the consent phone field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -211082,7 +206058,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the consent phone field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -211090,11 +206066,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the consent phone field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "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}" + "value": "export interface ConsentPhoneFieldElementEvents {\n /**\n * A callback fired when the consent phone field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the consent phone field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the consent phone field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the consent phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", @@ -211120,19 +206096,18 @@ "ConsentPhoneFieldElementSlots": { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "name": "ConsentPhoneFieldElementSlots", - "description": "The slots interface for the ConsentPhoneField component.", - "isPublicDocs": true, + "description": "The consent phone field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", "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.", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", "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}" + "value": "export interface ConsentPhoneFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" } } } @@ -211170,8 +206145,7 @@ "DateFieldElementProps": { "filePath": "src/surfaces/checkout/components/DateField.ts", "name": "DateFieldElementProps", - "description": "The element props interface for the DateField component.", - "isPublicDocs": true, + "description": "Configure the following properties on the date field component.", "members": [ { "filePath": "src/surfaces/checkout/components/DateField.ts", @@ -211220,16 +206194,16 @@ "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.", + "description": "A hint about the intended content of the field for browser autofill.\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.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", "isOptional": true, - "defaultValue": "'on' for everything else" + "defaultValue": "'on'" }, { "filePath": "src/surfaces/checkout/components/DateField.ts", "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -211245,7 +206219,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -211296,7 +206270,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -211304,7 +206278,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -211312,7 +206286,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -211320,7 +206294,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -211338,7 +206312,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -211394,15 +206368,14 @@ "DateFieldElementEvents": { "filePath": "src/surfaces/checkout/components/DateField.ts", "name": "DateFieldElementEvents", - "description": "The events interface for the DateField component.", - "isPublicDocs": true, + "description": "The date field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "members": [ { "filePath": "src/surfaces/checkout/components/DateField.ts", "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the date field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -211410,7 +206383,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the date field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -211418,7 +206391,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the date field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -211426,7 +206399,7 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the date field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true }, { @@ -211434,7 +206407,7 @@ "syntaxKind": "PropertySignature", "name": "invalid", "value": "CallbackEventListener", - "description": "Callback when the user enters an invalid date.", + "description": "A callback fired when the date field value is invalid.\n\nLearn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).", "isOptional": true }, { @@ -211442,11 +206415,11 @@ "syntaxKind": "PropertySignature", "name": "viewChange", "value": "CallbackEventListener", - "description": "Callback when the view changes.", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", "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}" + "value": "export interface DateFieldElementEvents {\n /**\n * A callback fired when the date field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the date field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the date field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the date field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the date field value is invalid.\n *\n * Learn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).\n */\n invalid?: CallbackEventListener;\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewChange?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/DateField.ts", @@ -211498,8 +206471,7 @@ "DatePickerElementProps": { "filePath": "src/surfaces/checkout/components/DatePicker.ts", "name": "DatePickerElementProps", - "description": "The element props interface for the DatePicker component.", - "isPublicDocs": true, + "description": "Configure the following properties on the date picker component.", "members": [ { "filePath": "src/surfaces/checkout/components/DatePicker.ts", @@ -211565,7 +206537,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -211616,7 +206588,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -211624,7 +206596,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -211666,15 +206638,14 @@ "DatePickerElementEvents": { "filePath": "src/surfaces/checkout/components/DatePicker.ts", "name": "DatePickerElementEvents", - "description": "The events interface for the DatePicker component.", - "isPublicDocs": true, + "description": "The date picker component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "members": [ { "filePath": "src/surfaces/checkout/components/DatePicker.ts", "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the date picker loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -211682,7 +206653,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the date picker value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -211690,7 +206661,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the date picker receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -211698,7 +206669,7 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the date picker.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "isOptional": true }, { @@ -211706,11 +206677,11 @@ "syntaxKind": "PropertySignature", "name": "viewChange", "value": "CallbackEventListener", - "description": "Callback when the view changes.", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", "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}" + "value": "export interface DatePickerElementEvents {\n /**\n * A callback fired when the date picker loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the date picker value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the date picker receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the date picker.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewChange?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/DatePicker.ts", @@ -211763,7 +206734,6 @@ "filePath": "src/surfaces/checkout/components/Details.ts", "name": "DetailsElementProps", "description": "The element props interface for the Details component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Details.ts", @@ -211779,7 +206749,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -211814,7 +206784,6 @@ "filePath": "src/surfaces/checkout/components/Details.ts", "name": "DetailsElementEvents", "description": "The events interface for the Details component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Details.ts", @@ -211891,14 +206860,13 @@ "filePath": "src/surfaces/checkout/components/Summary.ts", "name": "SummaryElementProps", "description": "The element props interface for the Summary component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Summary.ts", "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -211941,7 +206909,6 @@ "filePath": "src/surfaces/checkout/components/Divider.ts", "name": "DividerElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Divider.ts", @@ -211957,7 +206924,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -211999,8 +206966,7 @@ "DropZoneElementProps": { "filePath": "src/surfaces/checkout/components/DropZone.ts", "name": "DropZoneElementProps", - "description": "The element props interface for the DropZone component.", - "isPublicDocs": true, + "description": "Configure the following properties on the drop zone component.", "members": [ { "filePath": "src/surfaces/checkout/components/DropZone.ts", @@ -212024,7 +206990,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -212033,7 +206999,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -212041,7 +207007,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -212049,7 +207015,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -212066,7 +207032,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -212100,15 +207066,14 @@ "DropZoneElementEvents": { "filePath": "src/surfaces/checkout/components/DropZone.ts", "name": "DropZoneElementEvents", - "description": "The events interface for the DropZone component.", - "isPublicDocs": true, + "description": "The drop zone component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "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.", + "description": "A callback fired when the drop zone value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -212116,7 +207081,7 @@ "syntaxKind": "PropertySignature", "name": "droprejected", "value": "CallbackEventListener", - "description": "Callback when rejected files are dropped. Files are rejected based on the `accept` prop.", + "description": "A callback fired when files are rejected based on the `accept` prop.", "isOptional": true }, { @@ -212124,11 +207089,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the drop zone.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "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}" + "value": "export interface DropZoneElementEvents {\n /**\n * A callback fired when files are rejected based on the `accept` prop.\n */\n droprejected?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the drop zone.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the drop zone value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/DropZone.ts", @@ -212187,24 +207152,23 @@ "EmailFieldElementProps": { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementProps", - "description": "The element props interface for the EmailField component.", - "isPublicDocs": true, + "description": "Configure the following properties on the email field component.", "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.", + "description": "A hint about the intended content of the field for browser autofill.\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.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", "isOptional": true, - "defaultValue": "'on' for everything else" + "defaultValue": "'on'" }, { "filePath": "src/surfaces/checkout/components/EmailField.ts", "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -212212,7 +207176,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -212221,7 +207185,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -212229,7 +207193,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -212237,7 +207201,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -212245,7 +207209,7 @@ "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.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -212263,7 +207227,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -212272,7 +207236,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -212290,7 +207254,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -212338,15 +207302,14 @@ "EmailFieldElementEvents": { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementEvents", - "description": "The events interface for the EmailField component.", - "isPublicDocs": true, + "description": "The email field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "members": [ { "filePath": "src/surfaces/checkout/components/EmailField.ts", "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the email field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -212354,7 +207317,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the email field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -212362,7 +207325,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the email field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -212370,11 +207333,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the email field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "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}" + "value": "export interface EmailFieldElementEvents {\n /**\n * A callback fired when the email field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the email field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the email field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the email field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/EmailField.ts", @@ -212400,19 +207363,18 @@ "EmailFieldElementSlots": { "filePath": "src/surfaces/checkout/components/EmailField.ts", "name": "EmailFieldElementSlots", - "description": "The slots interface for the EmailField component.", - "isPublicDocs": true, + "description": "The email field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", "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.", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", "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}" + "value": "export interface EmailFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" } } } @@ -212450,8 +207412,7 @@ "FormElementProps": { "filePath": "src/surfaces/checkout/components/Form.ts", "name": "FormElementProps", - "description": "The element props interface for the Form component.", - "isPublicDocs": true, + "description": "Configure the following properties on the form component.", "members": [ { "filePath": "src/surfaces/checkout/components/Form.ts", @@ -212469,7 +207430,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -212485,19 +207446,18 @@ "FormElementEvents": { "filePath": "src/surfaces/checkout/components/Form.ts", "name": "FormElementEvents", - "description": "The events interface for the Form component.", - "isPublicDocs": true, + "description": "The form component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "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.", + "description": "A callback fired 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}" + "value": "export interface FormElementEvents {\n /**\n * A callback fired when the form is submitted.\n */\n submit?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/Form.ts", @@ -212557,7 +207517,6 @@ "filePath": "src/surfaces/checkout/components/Grid.ts", "name": "GridElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Grid.ts", @@ -212728,7 +207687,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -212915,16 +207874,14 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedAlignContentKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'", - "description": "The subset of `align-content` values available for the grid component.\n\n- `center`: Packs rows toward the center of the grid.\n- `start`: Packs rows toward the start of the block axis.\n- `end`: Packs rows toward the end of the block axis.\n- `normal`: Default browser behavior.\n- `space-between`: Distributes rows evenly with no space at the edges.\n- `space-around`: Distributes rows evenly with equal space around each.\n- `space-evenly`: Distributes rows with equal space between and at the edges.\n- `stretch`: Stretches rows to fill the available space.", - "isPublicDocs": true + "description": "The subset of `align-content` values available for the grid component.\n\n- `center`: Packs rows toward the center of the grid.\n- `start`: Packs rows toward the start of the block axis.\n- `end`: Packs rows toward the end of the block axis.\n- `normal`: Default browser behavior.\n- `space-between`: Distributes rows evenly with no space at the edges.\n- `space-around`: Distributes rows evenly with equal space around each.\n- `space-evenly`: Distributes rows with equal space between and at the edges.\n- `stretch`: Stretches rows to fill the available space." }, "ReducedAlignItemsKeyword": { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "TypeAliasDeclaration", "name": "ReducedAlignItemsKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'", - "description": "The subset of `align-items` values available for the grid component.\n\n- `center`: Centers items along the block axis.\n- `start`: Aligns items to the start of the block axis.\n- `end`: Aligns items to the end of the block axis.\n- `normal`: Default browser behavior.\n- `baseline`: Aligns items along their text baseline.\n- `stretch`: Stretches items to fill the cell along the block axis.", - "isPublicDocs": true + "description": "The subset of `align-items` values available for the grid component.\n\n- `center`: Centers items along the block axis.\n- `start`: Aligns items to the start of the block axis.\n- `end`: Aligns items to the end of the block axis.\n- `normal`: Default browser behavior.\n- `baseline`: Aligns items along their text baseline.\n- `stretch`: Stretches items to fill the cell along the block axis." }, "SizeUnitsOrAuto": { "filePath": "src/surfaces/checkout/components/components.ts", @@ -213137,7 +208094,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -213331,16 +208288,14 @@ "syntaxKind": "TypeAliasDeclaration", "name": "ReducedJustifyContentKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'", - "description": "The subset of `justify-content` values available for the grid component.\n\n- `center`: Packs columns toward the center of the grid.\n- `start`: Packs columns toward the start of the inline axis.\n- `end`: Packs columns toward the end of the inline axis.\n- `normal`: Default browser behavior.\n- `space-between`: Distributes columns evenly with no space at the edges.\n- `space-around`: Distributes columns evenly with equal space around each.\n- `space-evenly`: Distributes columns with equal space between and at the edges.\n- `stretch`: Stretches columns to fill the available space.", - "isPublicDocs": true + "description": "The subset of `justify-content` values available for the grid component.\n\n- `center`: Packs columns toward the center of the grid.\n- `start`: Packs columns toward the start of the inline axis.\n- `end`: Packs columns toward the end of the inline axis.\n- `normal`: Default browser behavior.\n- `space-between`: Distributes columns evenly with no space at the edges.\n- `space-around`: Distributes columns evenly with equal space around each.\n- `space-evenly`: Distributes columns with equal space between and at the edges.\n- `stretch`: Stretches columns to fill the available space." }, "ReducedJustifyItemsKeyword": { "filePath": "src/surfaces/checkout/components/Grid.ts", "syntaxKind": "TypeAliasDeclaration", "name": "ReducedJustifyItemsKeyword", "value": "'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'", - "description": "The subset of `justify-items` values available for the grid component.\n\n- `center`: Centers items along the inline axis.\n- `start`: Aligns items to the start of the inline axis.\n- `end`: Aligns items to the end of the inline axis.\n- `normal`: Default browser behavior.\n- `baseline`: Aligns items along their text baseline.\n- `stretch`: Stretches items to fill the cell along the inline axis.", - "isPublicDocs": true + "description": "The subset of `justify-items` values available for the grid component.\n\n- `center`: Centers items along the inline axis.\n- `start`: Aligns items to the start of the inline axis.\n- `end`: Aligns items to the end of the inline axis.\n- `normal`: Default browser behavior.\n- `baseline`: Aligns items along their text baseline.\n- `stretch`: Stretches items to fill the cell along the inline axis." }, "SizeUnitsOrNone": { "filePath": "src/surfaces/checkout/components/components.ts", @@ -213367,7 +208322,6 @@ "filePath": "src/surfaces/checkout/components/GridItem.ts", "name": "GridItemElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/GridItem.ts", @@ -213502,7 +208456,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -213814,7 +208768,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -214002,7 +208956,6 @@ "filePath": "src/surfaces/checkout/components/Heading.ts", "name": "HeadingElementProps", "description": "The element props interface for the Heading component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Heading.ts", @@ -214018,7 +208971,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -214080,14 +209033,13 @@ "filePath": "src/surfaces/checkout/components/Icon.ts", "name": "IconElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Icon.ts", "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -214163,7 +209115,6 @@ "filePath": "src/surfaces/checkout/components/Image.ts", "name": "ImageElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Image.ts", @@ -214245,7 +209196,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -214408,7 +209359,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -214509,7 +209460,6 @@ "filePath": "src/surfaces/checkout/components/Link.ts", "name": "LinkElementProps", "description": "Configure the following properties on the link component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Link.ts", @@ -214549,7 +209499,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -214600,7 +209550,6 @@ "filePath": "src/surfaces/checkout/components/Link.ts", "name": "LinkElementEvents", "description": "The link component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Link.ts", @@ -214671,7 +209620,6 @@ "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Map.ts", @@ -214703,7 +209651,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -214838,7 +209786,6 @@ "filePath": "src/surfaces/checkout/components/Map.ts", "name": "MapElementEvents", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Map.ts", @@ -214980,7 +209927,6 @@ "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/MapMarker.ts", @@ -215087,7 +210033,6 @@ "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerElementEvents", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/MapMarker.ts", @@ -215125,7 +210070,6 @@ "filePath": "src/surfaces/checkout/components/MapMarker.ts", "name": "MapMarkerElementSlots", "description": "The named slots for the map marker component. Slots allow you to insert custom content into specific areas of the marker.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/MapMarker.ts", @@ -215204,7 +210148,6 @@ "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Modal.ts", @@ -215227,7 +210170,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -215262,7 +210205,6 @@ "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementEvents", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Modal.ts", @@ -215324,7 +210266,6 @@ "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementSlots", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Modal.ts", @@ -215356,7 +210297,6 @@ "filePath": "src/surfaces/checkout/components/Modal.ts", "name": "ModalElementMethods", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Modal.ts", @@ -215404,24 +210344,23 @@ "MoneyFieldElementProps": { "filePath": "src/surfaces/checkout/components/MoneyField.ts", "name": "MoneyFieldElementProps", - "description": "The element props interface for the MoneyField component.", - "isPublicDocs": true, + "description": "Configure the following properties on the money field component.", "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.", + "description": "A hint about the intended content of the field for browser autofill.\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.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", "isOptional": true, - "defaultValue": "'on' for everything else" + "defaultValue": "'on'" }, { "filePath": "src/surfaces/checkout/components/MoneyField.ts", "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -215429,7 +210368,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -215438,7 +210377,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -215446,7 +210385,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -215454,7 +210393,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -215462,7 +210401,7 @@ "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.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -215471,7 +210410,7 @@ "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.", + "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 can still use the keyboard to input a number higher than the max. It's up to the developer to add appropriate validation.", "isOptional": true, "defaultValue": "Infinity" }, @@ -215480,7 +210419,7 @@ "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.", + "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 can still use the keyboard to input a number lower than the min. It's up to the developer to add appropriate validation.", "isOptional": true, "defaultValue": "-Infinity" }, @@ -215489,7 +210428,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -215497,7 +210436,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -215554,15 +210493,14 @@ "MoneyFieldElementEvents": { "filePath": "src/surfaces/checkout/components/MoneyField.ts", "name": "MoneyFieldElementEvents", - "description": "The events interface for the MoneyField component.", - "isPublicDocs": true, + "description": "The money field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "members": [ { "filePath": "src/surfaces/checkout/components/MoneyField.ts", "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the money field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -215570,7 +210508,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the money field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -215578,7 +210516,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the money field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -215586,11 +210524,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the money field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "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}" + "value": "export interface MoneyFieldElementEvents {\n /**\n * A callback fired when the money field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the money field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the money field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the money field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/MoneyField.ts", @@ -215642,24 +210580,23 @@ "NumberFieldElementProps": { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementProps", - "description": "The element props interface for the NumberField component.", - "isPublicDocs": true, + "description": "Configure the following properties on the number field component.", "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.", + "description": "A hint about the intended content of the field for browser autofill.\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.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", "isOptional": true, - "defaultValue": "'on' for everything else" + "defaultValue": "'on'" }, { "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.", + "description": "Sets the type of controls displayed in the field.\n\n- `'auto'`: The presence of the controls depends on the surface and context.\n- `'stepper'`: Displays buttons to increase or decrease the value 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 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.", "isOptional": true, "defaultValue": "'auto'" }, @@ -215668,7 +210605,7 @@ "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -215676,7 +210613,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -215685,7 +210622,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -215702,7 +210639,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -215710,7 +210647,7 @@ "syntaxKind": "PropertySignature", "name": "inputMode", "value": "'decimal' | 'numeric'", - "description": "Sets the virtual keyboard.", + "description": "Sets the virtual keyboard layout for the field.\n\n- `'decimal'`: A numeric keyboard with a decimal point, suitable for decimal numbers.\n- `'numeric'`: A numeric keyboard without a decimal point, suitable for integers.\n\nLearn more about the [inputMode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode).", "isOptional": true, "defaultValue": "'decimal'" }, @@ -215719,7 +210656,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -215727,7 +210664,7 @@ "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.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -215736,7 +210673,7 @@ "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.", + "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 can still use the keyboard to input a number higher than the max. It's up to the developer to add appropriate validation.", "isOptional": true, "defaultValue": "Infinity" }, @@ -215745,7 +210682,7 @@ "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.", + "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 can still use the keyboard to input a number lower than the min. It's up to the developer to add appropriate validation.", "isOptional": true, "defaultValue": "-Infinity" }, @@ -215754,7 +210691,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -215772,7 +210709,7 @@ "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.", + "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 can't 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": "''" }, @@ -215781,7 +210718,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -215808,7 +210745,7 @@ "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.", + "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 can't 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": "''" }, @@ -215847,15 +210784,14 @@ "NumberFieldElementEvents": { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementEvents", - "description": "The events interface for the NumberField component.", - "isPublicDocs": true, + "description": "The number field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "members": [ { "filePath": "src/surfaces/checkout/components/NumberField.ts", "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the number field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -215863,7 +210799,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the number field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -215871,7 +210807,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the number field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -215879,11 +210815,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the number field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "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}" + "value": "export interface NumberFieldElementEvents {\n /**\n * A callback fired when the number field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the number field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the number field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the number field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/NumberField.ts", @@ -215909,19 +210845,18 @@ "NumberFieldElementSlots": { "filePath": "src/surfaces/checkout/components/NumberField.ts", "name": "NumberFieldElementSlots", - "description": "The slots interface for the NumberField component.", - "isPublicDocs": true, + "description": "The number field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", "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.", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", "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}" + "value": "export interface NumberFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" } } } @@ -215960,14 +210895,13 @@ "filePath": "src/surfaces/checkout/components/OrderedList.ts", "name": "OrderedListElementProps", "description": "The element props interface for the OrderedList component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/OrderedList.ts", "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -215984,14 +210918,13 @@ "filePath": "src/surfaces/checkout/components/ListItem.ts", "name": "ListItemElementProps", "description": "The element props interface for the ListItem component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/ListItem.ts", "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -216041,7 +210974,6 @@ "filePath": "src/surfaces/checkout/components/Paragraph.ts", "name": "ParagraphElementProps", "description": "The element props interface for the Paragraph component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Paragraph.ts", @@ -216075,7 +211007,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -216158,24 +211090,23 @@ "PasswordFieldElementProps": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementProps", - "description": "The element props interface for the PasswordField component.", - "isPublicDocs": true, + "description": "Configure the following properties on the password field component.", "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.", + "description": "A hint about the intended content of the field for browser autofill.\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.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", "isOptional": true, - "defaultValue": "'on' for everything else" + "defaultValue": "'on'" }, { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -216183,7 +211114,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -216192,7 +211123,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -216200,7 +211131,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -216208,7 +211139,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -216216,7 +211147,7 @@ "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.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -216234,7 +211165,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -216243,7 +211174,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -216251,7 +211182,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -216299,15 +211230,14 @@ "PasswordFieldElementEvents": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementEvents", - "description": "The events interface for the PasswordField component.", - "isPublicDocs": true, + "description": "The password field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "members": [ { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the password field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -216315,7 +211245,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the password field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -216323,7 +211253,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the password field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -216331,11 +211261,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the password field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "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}" + "value": "export interface PasswordFieldElementEvents {\n /**\n * A callback fired when the password field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the password field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the password field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the password field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", @@ -216361,19 +211291,18 @@ "PasswordFieldElementSlots": { "filePath": "src/surfaces/checkout/components/PasswordField.ts", "name": "PasswordFieldElementSlots", - "description": "The slots interface for the PasswordField component.", - "isPublicDocs": true, + "description": "The password field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", "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.", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", "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}" + "value": "export interface PasswordFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" } } } @@ -216412,7 +211341,6 @@ "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", "name": "PaymentIconElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", @@ -216427,7 +211355,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -216499,16 +211427,16 @@ "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.", + "description": "A hint about the intended content of the field for browser autofill.\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.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", "isOptional": true, - "defaultValue": "'on' for everything else" + "defaultValue": "'on'" }, { "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -216516,7 +211444,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -216525,7 +211453,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -216533,7 +211461,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -216541,7 +211469,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -216549,7 +211477,7 @@ "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.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -216558,7 +211486,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -216576,7 +211504,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -216633,15 +211561,14 @@ "PhoneFieldElementEvents": { "filePath": "src/surfaces/checkout/components/PhoneField.ts", "name": "PhoneFieldElementEvents", - "description": "The events interface for the PhoneField component.", - "isPublicDocs": true, + "description": "The phone field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "members": [ { "filePath": "src/surfaces/checkout/components/PhoneField.ts", "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the phone field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -216649,7 +211576,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the phone field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -216657,7 +211584,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the phone field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -216665,11 +211592,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the phone field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "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}" + "value": "export interface PhoneFieldElementEvents {\n /**\n * A callback fired when the phone field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the phone field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the phone field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/PhoneField.ts", @@ -216695,19 +211622,18 @@ "PhoneFieldElementSlots": { "filePath": "src/surfaces/checkout/components/PhoneField.ts", "name": "PhoneFieldElementSlots", - "description": "The slots interface for the PhoneField component.", - "isPublicDocs": true, + "description": "The phone field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", "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.", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", "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}" + "value": "export interface PhoneFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" } } } @@ -216746,7 +211672,6 @@ "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Popover.ts", @@ -216762,7 +211687,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -216845,7 +211770,6 @@ "filePath": "src/surfaces/checkout/components/Popover.ts", "name": "PopoverElementEvents", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Popover.ts", @@ -216917,7 +211841,6 @@ "filePath": "src/surfaces/checkout/components/PressButton.ts", "name": "PressButtonElementProps", "description": "Configure the following properties on the press button component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/PressButton.ts", @@ -216950,7 +211873,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -217002,7 +211925,6 @@ "filePath": "src/surfaces/checkout/components/PressButton.ts", "name": "PressButtonElementEvents", "description": "The press button component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/PressButton.ts", @@ -217082,7 +212004,6 @@ "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", "name": "ProductThumbnailElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", @@ -217174,7 +212095,6 @@ "filePath": "src/surfaces/checkout/components/Progress.ts", "name": "ProgressElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Progress.ts", @@ -217189,7 +212109,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -217265,7 +212185,6 @@ "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/QRCode.ts", @@ -217298,7 +212217,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -217340,7 +212259,6 @@ "filePath": "src/surfaces/checkout/components/QRCode.ts", "name": "QRCodeElementEvents", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/QRCode.ts", @@ -217418,7 +212336,6 @@ "filePath": "src/surfaces/checkout/components/QueryContainer.ts", "name": "QueryContainerElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/QueryContainer.ts", @@ -217434,7 +212351,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -217477,7 +212394,6 @@ "filePath": "src/surfaces/checkout/components/ScrollBox.ts", "name": "ScrollBoxElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/ScrollBox.ts", @@ -217594,7 +212510,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -217888,7 +212804,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -218083,7 +212999,6 @@ "filePath": "src/surfaces/checkout/components/Section.ts", "name": "SectionElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Section.ts", @@ -218106,7 +213021,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -218161,24 +213076,23 @@ "SelectElementProps": { "filePath": "src/surfaces/checkout/components/Select.ts", "name": "SelectElementProps", - "description": "The element props interface for the Select component.", - "isPublicDocs": true, + "description": "Configure the following properties on the select component.", "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.", + "description": "A hint about the intended content of the field for browser autofill.\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.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", "isOptional": true, - "defaultValue": "'on' for everything else" + "defaultValue": "'on'" }, { "filePath": "src/surfaces/checkout/components/Select.ts", "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -218187,7 +213101,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -218195,7 +213109,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -218203,7 +213117,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -218211,7 +213125,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -218219,7 +213133,7 @@ "syntaxKind": "PropertySignature", "name": "placeholder", "value": "string", - "description": "A short hint that describes the expected value of the field.", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", "isOptional": true }, { @@ -218266,15 +213180,14 @@ "SelectElementEvents": { "filePath": "src/surfaces/checkout/components/Select.ts", "name": "SelectElementEvents", - "description": "The events interface for the Select component.", - "isPublicDocs": true, + "description": "The select component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "members": [ { "filePath": "src/surfaces/checkout/components/Select.ts", "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the select loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -218282,7 +213195,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the select value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -218290,11 +213203,11 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the select receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "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}" + "value": "export interface SelectElementEvents {\n /**\n * A callback fired when the select loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the select value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the select receives focus.\n *\n * Learn more about the [focus event](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", @@ -218320,8 +213233,7 @@ "OptionElementProps": { "filePath": "src/surfaces/checkout/components/Option.ts", "name": "OptionElementProps", - "description": "The element props interface for the Option component.", - "isPublicDocs": true, + "description": "Configure the following properties on the option component.", "members": [ { "filePath": "src/surfaces/checkout/components/Option.ts", @@ -218336,7 +213248,7 @@ "syntaxKind": "PropertySignature", "name": "defaultSelected", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is selected by default.", "isOptional": true, "defaultValue": "false" }, @@ -218345,7 +213257,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -218354,7 +213266,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -218362,7 +213274,7 @@ "syntaxKind": "PropertySignature", "name": "selected", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently selected.", "isOptional": true, "defaultValue": "false" }, @@ -218414,7 +213326,6 @@ "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Sheet.ts", @@ -218446,7 +213357,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -218463,7 +213374,6 @@ "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementEvents", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Sheet.ts", @@ -218525,7 +213435,6 @@ "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementSlots", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Sheet.ts", @@ -218557,7 +213466,6 @@ "filePath": "src/surfaces/checkout/components/Sheet.ts", "name": "SheetElementMethods", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Sheet.ts", @@ -218619,7 +213527,6 @@ "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", "name": "SkeletonParagraphElementProps", "description": "The element props interface for the SkeletonParagraph component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", @@ -218635,7 +213542,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -218678,7 +213585,6 @@ "filePath": "src/surfaces/checkout/components/Spinner.ts", "name": "SpinnerElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Spinner.ts", @@ -218693,7 +213599,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -218745,7 +213651,6 @@ "filePath": "src/surfaces/checkout/components/Stack.ts", "name": "StackElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Stack.ts", @@ -218889,7 +213794,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -219172,7 +214077,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -219452,8 +214357,7 @@ "SwitchElementProps": { "filePath": "src/surfaces/checkout/components/Switch.ts", "name": "SwitchElementProps", - "description": "The element props interface for the Switch component.", - "isPublicDocs": true, + "description": "Configure the following properties on the switch component.", "members": [ { "filePath": "src/surfaces/checkout/components/Switch.ts", @@ -219468,7 +214372,7 @@ "syntaxKind": "PropertySignature", "name": "checked", "value": "boolean", - "description": "Whether the control is active.", + "description": "Whether the control is currently checked.", "isOptional": true, "defaultValue": "false" }, @@ -219494,7 +214398,7 @@ "syntaxKind": "PropertySignature", "name": "defaultChecked", "value": "boolean", - "description": "Whether the control is active by default.", + "description": "Whether the control is checked by default.", "isOptional": true, "defaultValue": "false" }, @@ -219503,7 +214407,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the control, disallowing any interaction.", + "description": "Whether the control is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -219512,7 +214416,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -219520,7 +214424,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Visual content to use as the control label.", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", "isOptional": true }, { @@ -219528,7 +214432,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the control that is unique within the nearest containing `Form` component.", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -219552,19 +214456,18 @@ "SwitchElementEvents": { "filePath": "src/surfaces/checkout/components/Switch.ts", "name": "SwitchElementEvents", - "description": "The events interface for the Switch component.", - "isPublicDocs": true, + "description": "The switch component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "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.", + "description": "A callback fired when the switch value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "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}" + "value": "export interface SwitchElementEvents {\n /**\n * A callback fired when the switch value changes.\n *\n * Learn more about the [change event](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", @@ -219617,7 +214520,6 @@ "filePath": "src/surfaces/checkout/components/Text.ts", "name": "TextElementProps", "description": "The element props interface for the Text component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Text.ts", @@ -219660,7 +214562,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -219749,24 +214651,23 @@ "TextAreaElementProps": { "filePath": "src/surfaces/checkout/components/TextArea.ts", "name": "TextAreaElementProps", - "description": "The element props interface for the TextArea component.", - "isPublicDocs": true, + "description": "Configure the following properties on the text area component.", "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.", + "description": "A hint about the intended content of the field for browser autofill.\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.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", "isOptional": true, - "defaultValue": "'on' for everything else" + "defaultValue": "'on'" }, { "filePath": "src/surfaces/checkout/components/TextArea.ts", "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -219774,7 +214675,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -219783,7 +214684,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -219791,7 +214692,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -219799,7 +214700,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -219807,7 +214708,7 @@ "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.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -219825,7 +214726,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -219834,7 +214735,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -219852,7 +214753,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -219909,15 +214810,14 @@ "TextAreaElementEvents": { "filePath": "src/surfaces/checkout/components/TextArea.ts", "name": "TextAreaElementEvents", - "description": "The events interface for the TextArea component.", - "isPublicDocs": true, + "description": "The text area component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "members": [ { "filePath": "src/surfaces/checkout/components/TextArea.ts", "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the text area loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -219925,7 +214825,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the text area value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -219933,7 +214833,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the text area receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -219941,11 +214841,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the text area.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "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}" + "value": "export interface TextAreaElementEvents {\n /**\n * A callback fired when the text area loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the text area value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the text area receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text area.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/TextArea.ts", @@ -219997,24 +214897,23 @@ "TextFieldElementProps": { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementProps", - "description": "The element props interface for the TextField component.", - "isPublicDocs": true, + "description": "Configure the following properties on the text field component.", "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.", + "description": "A hint about the intended content of the field for browser autofill.\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.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", "isOptional": true, - "defaultValue": "'on' for everything else" + "defaultValue": "'on'" }, { "filePath": "src/surfaces/checkout/components/TextField.ts", "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -220022,7 +214921,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -220031,7 +214930,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -220048,7 +214947,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -220056,7 +214955,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -220064,7 +214963,7 @@ "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.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -220082,7 +214981,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -220091,7 +214990,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -220109,7 +215008,7 @@ "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.", + "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 can't 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": "''" }, @@ -220118,7 +215017,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -220136,7 +215035,7 @@ "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.", + "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 can't 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": "''" }, @@ -220175,15 +215074,14 @@ "TextFieldElementEvents": { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementEvents", - "description": "The events interface for the TextField component.", - "isPublicDocs": true, + "description": "The text field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "members": [ { "filePath": "src/surfaces/checkout/components/TextField.ts", "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the text field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -220191,7 +215089,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the text field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -220199,7 +215097,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the text field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -220207,11 +215105,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the text field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "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}" + "value": "export interface TextFieldElementEvents {\n /**\n * A callback fired when the text field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the text field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the text field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/TextField.ts", @@ -220237,19 +215135,18 @@ "TextFieldElementSlots": { "filePath": "src/surfaces/checkout/components/TextField.ts", "name": "TextFieldElementSlots", - "description": "The slots interface for the TextField component.", - "isPublicDocs": true, + "description": "The text field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", "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.", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", "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}" + "value": "export interface TextFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" } } } @@ -220295,7 +215192,6 @@ "filePath": "src/surfaces/checkout/components/Time.ts", "name": "TimeElementProps", "description": "The element props interface for the Time component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Time.ts", @@ -220311,7 +215207,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -220361,14 +215257,13 @@ "filePath": "src/surfaces/checkout/components/Tooltip.ts", "name": "TooltipElementProps", "description": "", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/Tooltip.ts", "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -220411,14 +215306,13 @@ "filePath": "src/surfaces/checkout/components/UnorderedList.ts", "name": "UnorderedListElementProps", "description": "The element props interface for the UnorderedList component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/UnorderedList.ts", "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -220435,14 +215329,13 @@ "filePath": "src/surfaces/checkout/components/ListItem.ts", "name": "ListItemElementProps", "description": "The element props interface for the ListItem component.", - "isPublicDocs": true, "members": [ { "filePath": "src/surfaces/checkout/components/ListItem.ts", "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true } ], @@ -220491,24 +215384,23 @@ "URLFieldElementProps": { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementProps", - "description": "The element props interface for the UrlField component.", - "isPublicDocs": true, + "description": "Configure the following properties on the URL field component.", "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.", + "description": "A hint about the intended content of the field for browser autofill.\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.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", "isOptional": true, - "defaultValue": "'on' for everything else" + "defaultValue": "'on'" }, { "filePath": "src/surfaces/checkout/components/UrlField.ts", "syntaxKind": "PropertySignature", "name": "defaultValue", "value": "string", - "description": "The default value for the field.", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", "isOptional": true }, { @@ -220516,7 +215408,7 @@ "syntaxKind": "PropertySignature", "name": "disabled", "value": "boolean", - "description": "Disables the field, disallowing any interaction.", + "description": "Whether the field is disabled, preventing any user interaction.", "isOptional": true, "defaultValue": "false" }, @@ -220525,7 +215417,7 @@ "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.", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", "isOptional": true }, { @@ -220533,7 +215425,7 @@ "syntaxKind": "PropertySignature", "name": "id", "value": "string", - "description": "A unique identifier for the element.", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", "isOptional": true }, { @@ -220541,7 +215433,7 @@ "syntaxKind": "PropertySignature", "name": "label", "value": "string", - "description": "Content to use as the field label.", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", "isOptional": true }, { @@ -220549,7 +215441,7 @@ "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.", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", "isOptional": true, "defaultValue": "'visible'" }, @@ -220567,7 +215459,7 @@ "syntaxKind": "PropertySignature", "name": "minLength", "value": "number", - "description": "Specifies the min number of characters allowed.", + "description": "Specifies the minimum number of characters allowed.", "isOptional": true, "defaultValue": "0" }, @@ -220576,7 +215468,7 @@ "syntaxKind": "PropertySignature", "name": "name", "value": "string", - "description": "An identifier for the field that is unique within the nearest containing form.", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", "isOptional": true }, { @@ -220584,7 +215476,7 @@ "syntaxKind": "PropertySignature", "name": "readOnly", "value": "boolean", - "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers.", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", "isOptional": true, "defaultValue": "false" }, @@ -220632,15 +215524,14 @@ "URLFieldElementEvents": { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementEvents", - "description": "The events interface for the UrlField component.", - "isPublicDocs": true, + "description": "The URL field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", "members": [ { "filePath": "src/surfaces/checkout/components/UrlField.ts", "syntaxKind": "PropertySignature", "name": "blur", "value": "CallbackEventListener", - "description": "Callback when the element loses focus.", + "description": "A callback fired when the URL field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", "isOptional": true }, { @@ -220648,7 +215539,7 @@ "syntaxKind": "PropertySignature", "name": "change", "value": "CallbackEventListener", - "description": "Callback when the user has **finished editing** a field, e.g. once they have blurred the field.", + "description": "A callback fired when the URL field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", "isOptional": true }, { @@ -220656,7 +215547,7 @@ "syntaxKind": "PropertySignature", "name": "focus", "value": "CallbackEventListener", - "description": "Callback when the element receives focus.", + "description": "A callback fired when the URL field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", "isOptional": true }, { @@ -220664,11 +215555,11 @@ "syntaxKind": "PropertySignature", "name": "input", "value": "CallbackEventListener", - "description": "Callback when the user makes any changes in the field.", + "description": "A callback fired when the user inputs data into the URL field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", "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}" + "value": "export interface URLFieldElementEvents {\n /**\n * A callback fired when the URL field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the URL field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the URL field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the URL field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" }, "CallbackEventListener": { "filePath": "src/surfaces/checkout/components/UrlField.ts", @@ -220694,19 +215585,18 @@ "URLFieldElementSlots": { "filePath": "src/surfaces/checkout/components/UrlField.ts", "name": "URLFieldElementSlots", - "description": "The slots interface for the UrlField component.", - "isPublicDocs": true, + "description": "The URL field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", "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.", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", "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}" + "value": "export interface URLFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" } } }