diff --git a/docs-shopify.dev/configuration/admin-link.doc.ts b/docs-shopify.dev/configuration/admin-link.doc.ts new file mode 100644 index 0000000000..ad89c9e8f6 --- /dev/null +++ b/docs-shopify.dev/configuration/admin-link.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Admin Link', + description: 'Configuration reference for Admin Link.', + overviewPreviewDescription: 'Admin Link TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/admin-link.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'adminlink', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/app-configuration.doc.ts b/docs-shopify.dev/configuration/app-configuration.doc.ts new file mode 100644 index 0000000000..48221cab05 --- /dev/null +++ b/docs-shopify.dev/configuration/app-configuration.doc.ts @@ -0,0 +1,73 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'App configuration', + description: 'Reference for the shopify.app.toml configuration file.', + overviewPreviewDescription: 'shopify.app.toml configuration reference.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.app.toml', + code: './examples/app-configuration.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Global', + description: 'Global properties.', + type: 'global', + }, + { + title: 'App access', + description: 'App access properties.', + type: 'appaccess', + }, + { + title: 'Imperative Webhooks Api Version', + description: 'Imperative Webhooks Api Version properties.', + type: 'webhooks', + }, + { + title: 'App Proxy', + description: 'App Proxy properties.', + type: 'appproxy', + }, + { + title: 'Point Of Sale Configuration', + description: 'Point Of Sale Configuration properties.', + type: 'pointofsale', + }, + { + title: 'App Home', + description: 'App Home properties.', + type: 'apphome', + }, + { + title: 'Channel Configuration', + description: 'Channel Configuration properties.', + type: 'channelconfig', + }, + { + title: 'Customer Authentication', + description: 'Customer Authentication properties.', + type: 'customerauthentication', + }, + { + title: 'Custom data', + description: 'Custom data properties.', + type: 'data', + }, + ], + category: 'app-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/checkout-post-purchase.doc.ts b/docs-shopify.dev/configuration/checkout-post-purchase.doc.ts new file mode 100644 index 0000000000..623d98fc40 --- /dev/null +++ b/docs-shopify.dev/configuration/checkout-post-purchase.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Checkout Post Purchase', + description: 'Configuration reference for Checkout Post Purchase.', + overviewPreviewDescription: 'Checkout Post Purchase TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/checkout-post-purchase.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'checkoutpostpurchase', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/checkout-ui-extension.doc.ts b/docs-shopify.dev/configuration/checkout-ui-extension.doc.ts new file mode 100644 index 0000000000..e56dcbc72b --- /dev/null +++ b/docs-shopify.dev/configuration/checkout-ui-extension.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Checkout Extension', + description: 'Configuration reference for Checkout Extension.', + overviewPreviewDescription: 'Checkout Extension TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/checkout-ui-extension.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'checkoutuiextension', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/editor-extension-collection.doc.ts b/docs-shopify.dev/configuration/editor-extension-collection.doc.ts new file mode 100644 index 0000000000..fb3dffaee0 --- /dev/null +++ b/docs-shopify.dev/configuration/editor-extension-collection.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Editor extension collection', + description: 'Configuration reference for Editor extension collection.', + overviewPreviewDescription: 'Editor extension collection TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/editor-extension-collection.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'editorextensioncollection', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/examples/admin-link.example.toml b/docs-shopify.dev/configuration/examples/admin-link.example.toml new file mode 100644 index 0000000000..ea5f76c718 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/admin-link.example.toml @@ -0,0 +1,32 @@ +name = "Admin Link" +type = "admin_link" + +description = "example" +[[targeting]] +url = "example" +target = "admin.abandoned-checkout-details.action.link" +tools = "example" +instructions = "example" +[targeting.build_manifest] +[targeting.build_manifest.assets] +[targeting.build_manifest.assets.tools] +filepath = "example" +module = "example" +static = true + +[targeting.build_manifest.assets.instructions] +filepath = "example" +module = "example" +static = true + +[[targeting.build_manifest.assets.intents]] +filepath = "example" +module = "example" +static = true + + + +[[targeting.intents]] +action = "example" +type = "example" +schema = "example" diff --git a/docs-shopify.dev/configuration/examples/app-configuration.example.toml b/docs-shopify.dev/configuration/examples/app-configuration.example.toml new file mode 100644 index 0000000000..3a53b490ab --- /dev/null +++ b/docs-shopify.dev/configuration/examples/app-configuration.example.toml @@ -0,0 +1,187 @@ +# Global +client_id = "example" +extension_directories = ["example"] +web_directories = ["example"] +name = "example" +handle = "example" +[build] +automatically_update_urls_on_dev = true +dev_store_url = "example" +include_config_on_deploy = true + + +# App access +[access] +[access.admin] +direct_api_mode = "online" +embedded_app_direct_api_access = true + + +[access_scopes] +scopes = "example" +required_scopes = ["example"] +optional_scopes = ["example"] +use_legacy_install_flow = true + +[auth] +redirect_urls = ["example"] + + +# Imperative Webhooks Api Version +[webhooks] +api_version = "example" +[webhooks.privacy_compliance] +customer_deletion_url = "example" +customer_data_request_url = "example" +shop_deletion_url = "example" + +[[webhooks.subscriptions]] +topics = ["example"] +actions = ["example"] +uri = "example" +include_fields = ["example"] +filter = "example" +payload_query = "example" +name = "example" +compliance_topics = ["example"] + + + +# App Proxy +[app_proxy] +url = "example" +subpath = "example" +prefix = "example" + + +# Point Of Sale Configuration +[pos] +embedded = true + + +# App Home +application_url = "example" +embedded = true +[app_preferences] +url = "example" + + +# Channel Configuration +create_legacy_channel_on_app_install = true + +# Customer Authentication +[customer_authentication] +redirect_uris = ["example"] +javascript_origins = ["example"] +logout_urls = ["example"] + + +# Custom data +[metafields] +api_version = "2025-04" + +[company] +[company.metafields] + + +[company_location] +[company_location.metafields] + + +[payment_customization] +[payment_customization.metafields] + + +[validation] +[validation.metafields] + + +[customer] +[customer.metafields] +standard_metafields = ["example"] + + +[delivery_customization] +[delivery_customization.metafields] + + +[draft_order] +[draft_order.metafields] + + +[gift_card_transaction] +[gift_card_transaction.metafields] + + +[market] +[market.metafields] + + +[cart_transform] +[cart_transform.metafields] + + +[collection] +[collection.metafields] + + +[product] +[product.metafields] +standard_metafields = ["example"] + + +[variant] +[variant.metafields] +standard_metafields = ["example"] + + +[selling_plan] +[selling_plan.metafields] + + +[article] +[article.metafields] + + +[blog] +[blog.metafields] + + +[page] +[page.metafields] + + +[fulfillment_constraint_rule] +[fulfillment_constraint_rule.metafields] + + +[order_routing_location_rule] +[order_routing_location_rule.metafields] + + +[discount] +[discount.metafields] + + +[order] +[order.metafields] + + +[location] +[location.metafields] + + +[shop] +[shop.metafields] + + +[delivery_method] +[delivery_method.metafields] + + +[delivery_option_generator] +[delivery_option_generator.metafields] + + +[metaobjects] +standard_metaobjects = ["example"] diff --git a/docs-shopify.dev/configuration/examples/checkout-post-purchase.example.toml b/docs-shopify.dev/configuration/examples/checkout-post-purchase.example.toml new file mode 100644 index 0000000000..1301fd0922 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/checkout-post-purchase.example.toml @@ -0,0 +1,38 @@ +name = "Checkout Post Purchase" +type = "checkout_post_purchase" + +uid = "example" +description = "example" +api_version = "example" +extension_points = "example" +[capabilities] +network_access = true +block_progress = true +api_access = true +[capabilities.collect_buyer_consent] +sms_marketing = true +customer_privacy = true + +[capabilities.iframe] +sources = ["example"] + + +[supported_features] +runs_offline = true + +[settings] +[[settings.fields]] +key = "example" +name = "example" +description = "example" +required = true +default_value = "example" +type = "example" +validations = "example" +marketingActivityCreateUrl = "example" +marketingActivityDeleteUrl = "example" + + +[[metafields]] +namespace = "example" +key = "example" diff --git a/docs-shopify.dev/configuration/examples/checkout-ui-extension.example.toml b/docs-shopify.dev/configuration/examples/checkout-ui-extension.example.toml new file mode 100644 index 0000000000..8e931e9755 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/checkout-ui-extension.example.toml @@ -0,0 +1,28 @@ +name = "Checkout Extension" +type = "checkout_ui_extension" + +uid = "example" +description = "example" +api_version = "example" +extension_points = ["example"] +[capabilities] +network_access = true +block_progress = true +api_access = true +[capabilities.collect_buyer_consent] +sms_marketing = true +customer_privacy = true + +[capabilities.iframe] +sources = ["example"] + + +[supported_features] +runs_offline = true + +[settings] +fields = "example" + +[[metafields]] +namespace = "example" +key = "example" diff --git a/docs-shopify.dev/configuration/examples/editor-extension-collection.example.toml b/docs-shopify.dev/configuration/examples/editor-extension-collection.example.toml new file mode 100644 index 0000000000..3201ea1f77 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/editor-extension-collection.example.toml @@ -0,0 +1,38 @@ +name = "Editor extension collection" +type = "editor_extension_collection" + +uid = "example" +description = "example" +api_version = "example" +extension_points = "example" +includes = ["example"] +[capabilities] +network_access = true +block_progress = true +api_access = true +[capabilities.collect_buyer_consent] +sms_marketing = true +customer_privacy = true + +[capabilities.iframe] +sources = ["example"] + + +[supported_features] +runs_offline = true + +[settings] +[[settings.fields]] +key = "example" +name = "example" +description = "example" +required = true +default_value = "example" +type = "example" +validations = "example" +marketingActivityCreateUrl = "example" +marketingActivityDeleteUrl = "example" + + +[[include]] +handle = "example" diff --git a/docs-shopify.dev/configuration/examples/flow-action.example.toml b/docs-shopify.dev/configuration/examples/flow-action.example.toml new file mode 100644 index 0000000000..94c3d2a751 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/flow-action.example.toml @@ -0,0 +1,39 @@ +name = "Flow Action" +type = "flow_action" + +uid = "example" +description = "example" +api_version = "example" +extension_points = "example" +runtime_url = "example" +validation_url = "example" +config_page_url = "example" +config_page_preview_url = "example" +schema = "example" +return_type_ref = "example" +[capabilities] +network_access = true +block_progress = true +api_access = true +[capabilities.collect_buyer_consent] +sms_marketing = true +customer_privacy = true + +[capabilities.iframe] +sources = ["example"] + + +[supported_features] +runs_offline = true + +[settings] +[[settings.fields]] +key = "example" +name = "example" +description = "example" +required = true +default_value = "example" +type = "example" +validations = "example" +marketingActivityCreateUrl = "example" +marketingActivityDeleteUrl = "example" diff --git a/docs-shopify.dev/configuration/examples/flow-template.example.toml b/docs-shopify.dev/configuration/examples/flow-template.example.toml new file mode 100644 index 0000000000..ccb881e765 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/flow-template.example.toml @@ -0,0 +1,42 @@ +name = "Flow Template" +type = "flow_template" + +uid = "example" +description = "example" +api_version = "example" +extension_points = "example" +[capabilities] +network_access = true +block_progress = true +api_access = true +[capabilities.collect_buyer_consent] +sms_marketing = true +customer_privacy = true + +[capabilities.iframe] +sources = ["example"] + + +[supported_features] +runs_offline = true + +[settings] +[[settings.fields]] +key = "example" +name = "example" +description = "example" +required = true +default_value = "example" +type = "example" +validations = "example" +marketingActivityCreateUrl = "example" +marketingActivityDeleteUrl = "example" + + +[template] +categories = ["example"] +module = "example" +require_app = true +discoverable = true +allow_one_click_activate = true +enabled = true diff --git a/docs-shopify.dev/configuration/examples/flow-trigger-lifecycle-callback.example.toml b/docs-shopify.dev/configuration/examples/flow-trigger-lifecycle-callback.example.toml new file mode 100644 index 0000000000..95ca70096c --- /dev/null +++ b/docs-shopify.dev/configuration/examples/flow-trigger-lifecycle-callback.example.toml @@ -0,0 +1,4 @@ +name = "Flow Trigger Lifecycle Callback" +type = "flow_trigger_lifecycle_callback" + +url = "example" diff --git a/docs-shopify.dev/configuration/examples/flow-trigger.example.toml b/docs-shopify.dev/configuration/examples/flow-trigger.example.toml new file mode 100644 index 0000000000..9e40c04828 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/flow-trigger.example.toml @@ -0,0 +1,34 @@ +name = "Flow Trigger" +type = "flow_trigger" + +uid = "example" +description = "example" +api_version = "example" +extension_points = "example" +schema = "example" +[capabilities] +network_access = true +block_progress = true +api_access = true +[capabilities.collect_buyer_consent] +sms_marketing = true +customer_privacy = true + +[capabilities.iframe] +sources = ["example"] + + +[supported_features] +runs_offline = true + +[settings] +[[settings.fields]] +key = "example" +name = "example" +description = "example" +required = true +default_value = "example" +type = "example" +validations = "example" +marketingActivityCreateUrl = "example" +marketingActivityDeleteUrl = "example" diff --git a/docs-shopify.dev/configuration/examples/function.example.toml b/docs-shopify.dev/configuration/examples/function.example.toml new file mode 100644 index 0000000000..cd6b76de59 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/function.example.toml @@ -0,0 +1,61 @@ +name = "function" +type = "function" + +uid = "example" +description = "example" +api_version = "example" +extension_points = "example" +configuration_ui = true +[capabilities] +network_access = true +block_progress = true +api_access = true +[capabilities.collect_buyer_consent] +sms_marketing = true +customer_privacy = true + +[capabilities.iframe] +sources = ["example"] + + +[supported_features] +runs_offline = true + +[settings] +[[settings.fields]] +key = "example" +name = "example" +description = "example" +required = true +default_value = "example" +type = "example" +validations = "example" +marketingActivityCreateUrl = "example" +marketingActivityDeleteUrl = "example" + + +[build] +command = "example" +path = "example" +watch = "example" +wasm_opt = true +typegen_command = "example" + +[ui] +enable_create = true +handle = "example" +[ui.paths] +create = "example" +details = "example" + + +[input] +[input.variables] +namespace = "example" +key = "example" + + +[[targeting]] +target = "example" +input_query = "example" +export = "example" diff --git a/docs-shopify.dev/configuration/examples/marketing-activity.example.toml b/docs-shopify.dev/configuration/examples/marketing-activity.example.toml new file mode 100644 index 0000000000..4749873c7e --- /dev/null +++ b/docs-shopify.dev/configuration/examples/marketing-activity.example.toml @@ -0,0 +1,16 @@ +name = "Marketing Activity" +type = "marketing_activity" + +title = "example" +description = "example" +api_path = "example" +tactic = "ad" +marketing_channel = "social" +referring_domain = "example" +is_automation = true +use_external_editor = true +fields = ["example"] +[preview_data] +[[preview_data.types]] +label = "example" +value = "example" diff --git a/docs-shopify.dev/configuration/examples/payments-extension.example.toml b/docs-shopify.dev/configuration/examples/payments-extension.example.toml new file mode 100644 index 0000000000..f6703921c8 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/payments-extension.example.toml @@ -0,0 +1,2 @@ +name = "Payments Extension" +type = "payments_extension" diff --git a/docs-shopify.dev/configuration/examples/pos-ui-extension.example.toml b/docs-shopify.dev/configuration/examples/pos-ui-extension.example.toml new file mode 100644 index 0000000000..f2ba46700a --- /dev/null +++ b/docs-shopify.dev/configuration/examples/pos-ui-extension.example.toml @@ -0,0 +1,33 @@ +name = "POS UI Extension" +type = "pos_ui_extension" + +uid = "example" +description = "example" +api_version = "example" +extension_points = "example" +[capabilities] +network_access = true +block_progress = true +api_access = true +[capabilities.collect_buyer_consent] +sms_marketing = true +customer_privacy = true + +[capabilities.iframe] +sources = ["example"] + + +[supported_features] +runs_offline = true + +[settings] +[[settings.fields]] +key = "example" +name = "example" +description = "example" +required = true +default_value = "example" +type = "example" +validations = "example" +marketingActivityCreateUrl = "example" +marketingActivityDeleteUrl = "example" diff --git a/docs-shopify.dev/configuration/examples/product-subscription.example.toml b/docs-shopify.dev/configuration/examples/product-subscription.example.toml new file mode 100644 index 0000000000..0879811af7 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/product-subscription.example.toml @@ -0,0 +1,33 @@ +name = "Product Subscription" +type = "product_subscription" + +uid = "example" +description = "example" +api_version = "example" +extension_points = "example" +[capabilities] +network_access = true +block_progress = true +api_access = true +[capabilities.collect_buyer_consent] +sms_marketing = true +customer_privacy = true + +[capabilities.iframe] +sources = ["example"] + + +[supported_features] +runs_offline = true + +[settings] +[[settings.fields]] +key = "example" +name = "example" +description = "example" +required = true +default_value = "example" +type = "example" +validations = "example" +marketingActivityCreateUrl = "example" +marketingActivityDeleteUrl = "example" diff --git a/docs-shopify.dev/configuration/examples/subscription-link-extension.example.toml b/docs-shopify.dev/configuration/examples/subscription-link-extension.example.toml new file mode 100644 index 0000000000..ef7be97ca7 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/subscription-link-extension.example.toml @@ -0,0 +1,4 @@ +name = "Subscription Link" +type = "subscription_link_extension" + +pattern = "example" diff --git a/docs-shopify.dev/configuration/examples/theme.example.toml b/docs-shopify.dev/configuration/examples/theme.example.toml new file mode 100644 index 0000000000..1643cf9927 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/theme.example.toml @@ -0,0 +1,33 @@ +name = "Online Store - App Theme Extension" +type = "theme" + +uid = "example" +description = "example" +api_version = "example" +extension_points = "example" +[capabilities] +network_access = true +block_progress = true +api_access = true +[capabilities.collect_buyer_consent] +sms_marketing = true +customer_privacy = true + +[capabilities.iframe] +sources = ["example"] + + +[supported_features] +runs_offline = true + +[settings] +[[settings.fields]] +key = "example" +name = "example" +description = "example" +required = true +default_value = "example" +type = "example" +validations = "example" +marketingActivityCreateUrl = "example" +marketingActivityDeleteUrl = "example" diff --git a/docs-shopify.dev/configuration/examples/ui-extension.example.toml b/docs-shopify.dev/configuration/examples/ui-extension.example.toml new file mode 100644 index 0000000000..66904d709e --- /dev/null +++ b/docs-shopify.dev/configuration/examples/ui-extension.example.toml @@ -0,0 +1,83 @@ +name = "UI Extension" +type = "ui_extension" + +uid = "example" +description = "example" +api_version = "example" +[capabilities] +network_access = true +block_progress = true +api_access = true +[capabilities.collect_buyer_consent] +sms_marketing = true +customer_privacy = true + +[capabilities.iframe] +sources = ["example"] + + +[supported_features] +runs_offline = true + +[settings] +[[settings.fields]] +key = "example" +name = "example" +description = "example" +required = true +default_value = "example" +type = "example" +validations = "example" +marketingActivityCreateUrl = "example" +marketingActivityDeleteUrl = "example" + + +[[extension_points]] +target = "example" +module = "example" +tools = "example" +instructions = "example" +default_placement = "example" +[extension_points.should_render] +module = "example" + +[extension_points.urls] +edit = "example" + +[extension_points.capabilities] +allow_direct_linking = true + +[extension_points.preloads] +chat = "example" + +[[extension_points.metafields]] +namespace = "example" +key = "example" + + +[[targeting]] +target = "example" +module = "example" +tools = "example" +instructions = "example" +default_placement = "example" +[targeting.should_render] +module = "example" + +[targeting.urls] +edit = "example" + +[targeting.capabilities] +allow_direct_linking = true + +[targeting.preloads] +chat = "example" + +[[targeting.metafields]] +namespace = "example" +key = "example" + + +[[metafields]] +namespace = "example" +key = "example" diff --git a/docs-shopify.dev/configuration/examples/web-pixel-extension.example.toml b/docs-shopify.dev/configuration/examples/web-pixel-extension.example.toml new file mode 100644 index 0000000000..06d23300a9 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/web-pixel-extension.example.toml @@ -0,0 +1,31 @@ +name = "Web Pixel Extension" +type = "web_pixel_extension" + +uid = "example" +description = "example" +api_version = "example" +extension_points = "example" +settings = "example" +runtime_context = "example" +version = "example" +configuration = "example" +[capabilities] +network_access = true +block_progress = true +api_access = true +[capabilities.collect_buyer_consent] +sms_marketing = true +customer_privacy = true + +[capabilities.iframe] +sources = ["example"] + + +[supported_features] +runs_offline = true + +[customer_privacy] +analytics = true +preferences = true +marketing = true +sale_of_data = "enabled" diff --git a/docs-shopify.dev/configuration/examples/webhook-subscription.example.toml b/docs-shopify.dev/configuration/examples/webhook-subscription.example.toml new file mode 100644 index 0000000000..fff6f575e1 --- /dev/null +++ b/docs-shopify.dev/configuration/examples/webhook-subscription.example.toml @@ -0,0 +1,10 @@ +name = "Webhooks Subscriptions" +type = "webhook_subscription" + +topic = "example" +actions = ["example"] +api_version = "example" +uri = "example" +include_fields = ["example"] +filter = "example" +payload_query = "example" diff --git a/docs-shopify.dev/configuration/flow-action.doc.ts b/docs-shopify.dev/configuration/flow-action.doc.ts new file mode 100644 index 0000000000..691408011b --- /dev/null +++ b/docs-shopify.dev/configuration/flow-action.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Flow Action', + description: 'Configuration reference for Flow Action.', + overviewPreviewDescription: 'Flow Action TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/flow-action.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'flowaction', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/flow-template.doc.ts b/docs-shopify.dev/configuration/flow-template.doc.ts new file mode 100644 index 0000000000..a412e11f25 --- /dev/null +++ b/docs-shopify.dev/configuration/flow-template.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Flow Template', + description: 'Configuration reference for Flow Template.', + overviewPreviewDescription: 'Flow Template TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/flow-template.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'flowtemplate', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/flow-trigger-lifecycle-callback.doc.ts b/docs-shopify.dev/configuration/flow-trigger-lifecycle-callback.doc.ts new file mode 100644 index 0000000000..df304b48c7 --- /dev/null +++ b/docs-shopify.dev/configuration/flow-trigger-lifecycle-callback.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Flow Trigger Lifecycle Callback', + description: 'Configuration reference for Flow Trigger Lifecycle Callback.', + overviewPreviewDescription: 'Flow Trigger Lifecycle Callback TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/flow-trigger-lifecycle-callback.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'flowtriggerlifecyclecallback', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/flow-trigger.doc.ts b/docs-shopify.dev/configuration/flow-trigger.doc.ts new file mode 100644 index 0000000000..d3002f9c6e --- /dev/null +++ b/docs-shopify.dev/configuration/flow-trigger.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Flow Trigger', + description: 'Configuration reference for Flow Trigger.', + overviewPreviewDescription: 'Flow Trigger TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/flow-trigger.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'flowtrigger', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/function.doc.ts b/docs-shopify.dev/configuration/function.doc.ts new file mode 100644 index 0000000000..5cd604ff00 --- /dev/null +++ b/docs-shopify.dev/configuration/function.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'function', + description: 'Configuration reference for function.', + overviewPreviewDescription: 'function TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/function.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'functionConfig', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/interfaces/admin-link.interface.ts b/docs-shopify.dev/configuration/interfaces/admin-link.interface.ts new file mode 100644 index 0000000000..10b2904196 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/admin-link.interface.ts @@ -0,0 +1,70 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface adminlink { + /** Text to be displayed on the surface */ + 'name': string + + /** Description of the link */ + 'description'?: string + + 'targeting': object[] + + /** URL or app path to be navigated to when the link is clicked */ + 'targeting[].url': string + + /** Target in the surface where the link will be rendered */ + 'targeting[].target': 'admin.abandoned-checkout-details.action.link' | 'admin.discount-index.action.link' | 'admin.discount-index.selection-action.link' | 'admin.discount-details.action.link' | 'admin.customer-index.action.link' | 'admin.customer-index.selection-action.link' | 'admin.customer-details.action.link' | 'admin.order-index.action.link' | 'admin.order-index.selection-action.link' | 'admin.order-details.action.link' | 'admin.draft-order-details.action.link' | 'admin.draft-order-index.action.link' | 'admin.draft-order-index.selection-action.link' | 'admin.product-index.action.link' | 'admin.product-index.selection-action.link' | 'admin.product-details.action.link' | 'admin.product-variant-details.action.link' | 'admin.product-variant-index.selection-action.link' | 'admin.collection-details.action.link' | 'admin.collection-index.action.link' | 'admin.order-fulfilled-card.action.link' | 'admin.app.support.link' | 'admin.page-index.action.link' | 'admin.page-details.action.link' | 'admin.blog-details.action.link' | 'admin.article-details.action.link' | 'admin.app.intent.link' + + /** App intents configuration for admin.app.intent.render target */ + 'targeting[].intents'?: object[] + + /** The intent action identifier */ + 'targeting[].intents[].action': string + + /** The intent type */ + 'targeting[].intents[].type': string + + /** Module reference for the schema */ + 'targeting[].intents[].schema': string + + /** Tools JSON schema */ + 'targeting[].tools'?: string + + /** Instructions markdown file */ + 'targeting[].instructions'?: string + + /** Schema files for intents */ + 'targeting[].build_manifest.assets.intents'?: object[] + + /** Path to the schema file to upload */ + 'targeting[].build_manifest.assets.intents[].filepath': string + + /** Module reference for the schema */ + 'targeting[].build_manifest.assets.intents[].module': string + + /** Whether the asset is static */ + 'targeting[].build_manifest.assets.intents[].static'?: boolean + + /** Path to the schema file to upload */ + 'targeting[].build_manifest.assets.tools.filepath': string + + /** Module reference for the schema */ + 'targeting[].build_manifest.assets.tools.module': string + + /** Whether the asset is static */ + 'targeting[].build_manifest.assets.tools.static'?: boolean + + /** Path to the schema file to upload */ + 'targeting[].build_manifest.assets.instructions.filepath': string + + /** Module reference for the schema */ + 'targeting[].build_manifest.assets.instructions.module': string + + /** Whether the asset is static */ + 'targeting[].build_manifest.assets.instructions.static'?: boolean + + /** Localization of the link text */ + 'localization'?: object + + /** Uploaded files for the module */ + 'uploaded_files'?: object +} diff --git a/docs-shopify.dev/configuration/interfaces/app-access.interface.ts b/docs-shopify.dev/configuration/interfaces/app-access.interface.ts new file mode 100644 index 0000000000..4567cae0dd --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/app-access.interface.ts @@ -0,0 +1,16 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface appaccess { + 'access.admin.direct_api_mode'?: 'online' | 'offline' + + 'access.admin.embedded_app_direct_api_access'?: boolean + + 'access_scopes.scopes'?: string + + 'access_scopes.required_scopes'?: string[] + + 'access_scopes.optional_scopes'?: string[] + + 'access_scopes.use_legacy_install_flow'?: boolean + + 'auth.redirect_urls': string[] +} diff --git a/docs-shopify.dev/configuration/interfaces/app-home.interface.ts b/docs-shopify.dev/configuration/interfaces/app-home.interface.ts new file mode 100644 index 0000000000..33458045ec --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/app-home.interface.ts @@ -0,0 +1,8 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface apphome { + 'application_url': string + + 'embedded': boolean + + 'app_preferences.url': string +} diff --git a/docs-shopify.dev/configuration/interfaces/app-proxy.interface.ts b/docs-shopify.dev/configuration/interfaces/app-proxy.interface.ts new file mode 100644 index 0000000000..f807f171a3 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/app-proxy.interface.ts @@ -0,0 +1,8 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface appproxy { + 'app_proxy.url': string + + 'app_proxy.subpath': string + + 'app_proxy.prefix': string +} diff --git a/docs-shopify.dev/configuration/interfaces/channel-config.interface.ts b/docs-shopify.dev/configuration/interfaces/channel-config.interface.ts new file mode 100644 index 0000000000..60e6bf3ea6 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/channel-config.interface.ts @@ -0,0 +1,6 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface channelconfig { + 'specifications'?: object + + 'create_legacy_channel_on_app_install'?: boolean +} diff --git a/docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts b/docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts new file mode 100644 index 0000000000..504d5ae399 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts @@ -0,0 +1,56 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface checkoutpostpurchase { + 'name'?: string + + 'type'?: string + + 'handle'?: string + + 'uid'?: string + + 'description'?: string + + 'api_version'?: string + + 'extension_points'?: unknown + + 'capabilities.network_access'?: boolean + + 'capabilities.block_progress'?: boolean + + 'capabilities.api_access'?: boolean + + 'capabilities.collect_buyer_consent.sms_marketing'?: boolean + + 'capabilities.collect_buyer_consent.customer_privacy'?: boolean + + 'capabilities.iframe.sources'?: string[] + + 'supported_features.runs_offline'?: boolean + + 'settings.fields'?: object[] + + 'settings.fields[].key'?: string + + 'settings.fields[].name'?: string + + 'settings.fields[].description'?: string + + 'settings.fields[].required'?: boolean + + 'settings.fields[].default_value'?: unknown + + 'settings.fields[].type': string + + 'settings.fields[].validations'?: unknown + + 'settings.fields[].marketingActivityCreateUrl'?: string + + 'settings.fields[].marketingActivityDeleteUrl'?: string + + 'metafields'?: object[] + + 'metafields[].namespace': string + + 'metafields[].key': string +} diff --git a/docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts b/docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts new file mode 100644 index 0000000000..e9b2834541 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts @@ -0,0 +1,38 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface checkoutuiextension { + 'name': string + + 'type'?: string + + 'handle'?: string + + 'uid'?: string + + 'description'?: string + + 'api_version'?: string + + 'extension_points'?: string[] + + 'capabilities.network_access'?: boolean + + 'capabilities.block_progress'?: boolean + + 'capabilities.api_access'?: boolean + + 'capabilities.collect_buyer_consent.sms_marketing'?: boolean + + 'capabilities.collect_buyer_consent.customer_privacy'?: boolean + + 'capabilities.iframe.sources'?: string[] + + 'supported_features.runs_offline'?: boolean + + 'settings.fields'?: unknown + + 'metafields'?: object[] + + 'metafields[].namespace': string + + 'metafields[].key': string +} diff --git a/docs-shopify.dev/configuration/interfaces/customer-authentication.interface.ts b/docs-shopify.dev/configuration/interfaces/customer-authentication.interface.ts new file mode 100644 index 0000000000..dfc0f22d8f --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/customer-authentication.interface.ts @@ -0,0 +1,11 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface customerauthentication { + /** Redirect URIs used for authentication flows */ + 'customer_authentication.redirect_uris': string[] + + /** JavaScript origins for customer authentication (scheme and host only, no paths or ports) */ + 'customer_authentication.javascript_origins'?: string[] + + /** Logout URLs for customer authentication */ + 'customer_authentication.logout_urls'?: string[] +} diff --git a/docs-shopify.dev/configuration/interfaces/data.interface.ts b/docs-shopify.dev/configuration/interfaces/data.interface.ts new file mode 100644 index 0000000000..238a270fff --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/data.interface.ts @@ -0,0 +1,95 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface data { + /** The Admin API lets you build apps and integrations that extend and enhance the Shopify admin. */ + 'metafields.api_version': '2025-04' | '2025-07' | '2025-10' | '2026-01' | '2026-04' | 'unstable' + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'company.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'company_location.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'payment_customization.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'validation.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'customer.metafields.app'?: object + + /** Array of standard metafield definition templates to enable. Each identifier is in the format 'namespace.key' (e.g. 'facts.isbn', 'reviews.rating'). These are pre-defined metafield definitions provided by Shopify. */ + 'customer.metafields.standard_metafields'?: string[] + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'delivery_customization.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'draft_order.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'gift_card_transaction.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'market.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'cart_transform.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'collection.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'product.metafields.app'?: object + + /** Array of standard metafield definition templates to enable. Each identifier is in the format 'namespace.key' (e.g. 'facts.isbn', 'reviews.rating'). These are pre-defined metafield definitions provided by Shopify. */ + 'product.metafields.standard_metafields'?: string[] + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'variant.metafields.app'?: object + + /** Array of standard metafield definition templates to enable. Each identifier is in the format 'namespace.key' (e.g. 'facts.isbn', 'reviews.rating'). These are pre-defined metafield definitions provided by Shopify. */ + 'variant.metafields.standard_metafields'?: string[] + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'selling_plan.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'article.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'blog.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'page.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'fulfillment_constraint_rule.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'order_routing_location_rule.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'discount.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'order.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'location.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'shop.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'delivery_method.metafields.app'?: object + + /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */ + 'delivery_option_generator.metafields.app'?: object + + /** Each entry here represents a metaobject definition. For instance, `[metaobjects.app.author]` becomes a metaobject definition of type `$app:author`. */ + 'metaobjects.app': object + + /** Array of standard metaobject definition templates to enable (e.g. 'shopify--qa-pair'). These are pre-defined metaobject definitions provided by Shopify. */ + 'metaobjects.standard_metaobjects'?: string[] +} diff --git a/docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts b/docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts new file mode 100644 index 0000000000..3c203d8db7 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts @@ -0,0 +1,56 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface editorextensioncollection { + 'name': string + + 'type': string + + 'handle'?: string + + 'uid'?: string + + 'description'?: string + + 'api_version'?: string + + 'extension_points'?: unknown + + 'capabilities.network_access'?: boolean + + 'capabilities.block_progress'?: boolean + + 'capabilities.api_access'?: boolean + + 'capabilities.collect_buyer_consent.sms_marketing'?: boolean + + 'capabilities.collect_buyer_consent.customer_privacy'?: boolean + + 'capabilities.iframe.sources'?: string[] + + 'supported_features.runs_offline'?: boolean + + 'settings.fields'?: object[] + + 'settings.fields[].key'?: string + + 'settings.fields[].name'?: string + + 'settings.fields[].description'?: string + + 'settings.fields[].required'?: boolean + + 'settings.fields[].default_value'?: unknown + + 'settings.fields[].type': string + + 'settings.fields[].validations'?: unknown + + 'settings.fields[].marketingActivityCreateUrl'?: string + + 'settings.fields[].marketingActivityDeleteUrl'?: string + + 'include'?: object[] + + 'include[].handle': string + + 'includes'?: string[] +} diff --git a/docs-shopify.dev/configuration/interfaces/flow-action.interface.ts b/docs-shopify.dev/configuration/interfaces/flow-action.interface.ts new file mode 100644 index 0000000000..087d769504 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/flow-action.interface.ts @@ -0,0 +1,62 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface flowaction { + 'name': string + + 'type': string + + 'handle': string + + 'uid'?: string + + 'description'?: string + + 'api_version'?: string + + 'extension_points'?: unknown + + 'capabilities.network_access'?: boolean + + 'capabilities.block_progress'?: boolean + + 'capabilities.api_access'?: boolean + + 'capabilities.collect_buyer_consent.sms_marketing'?: boolean + + 'capabilities.collect_buyer_consent.customer_privacy'?: boolean + + 'capabilities.iframe.sources'?: string[] + + 'supported_features.runs_offline'?: boolean + + 'settings.fields'?: object[] + + 'settings.fields[].key'?: string + + 'settings.fields[].name'?: string + + 'settings.fields[].description'?: string + + 'settings.fields[].required'?: boolean + + 'settings.fields[].default_value'?: unknown + + 'settings.fields[].type': string + + 'settings.fields[].validations'?: unknown + + 'settings.fields[].marketingActivityCreateUrl'?: string + + 'settings.fields[].marketingActivityDeleteUrl'?: string + + 'runtime_url': string + + 'validation_url'?: string + + 'config_page_url'?: string + + 'config_page_preview_url'?: string + + 'schema'?: string + + 'return_type_ref'?: string +} diff --git a/docs-shopify.dev/configuration/interfaces/flow-template.interface.ts b/docs-shopify.dev/configuration/interfaces/flow-template.interface.ts new file mode 100644 index 0000000000..c1cdc1a9b7 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/flow-template.interface.ts @@ -0,0 +1,62 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface flowtemplate { + 'name': string + + 'type': string + + 'handle': string + + 'uid'?: string + + 'description': string + + 'api_version'?: string + + 'extension_points'?: unknown + + 'capabilities.network_access'?: boolean + + 'capabilities.block_progress'?: boolean + + 'capabilities.api_access'?: boolean + + 'capabilities.collect_buyer_consent.sms_marketing'?: boolean + + 'capabilities.collect_buyer_consent.customer_privacy'?: boolean + + 'capabilities.iframe.sources'?: string[] + + 'supported_features.runs_offline'?: boolean + + 'settings.fields'?: object[] + + 'settings.fields[].key'?: string + + 'settings.fields[].name'?: string + + 'settings.fields[].description'?: string + + 'settings.fields[].required'?: boolean + + 'settings.fields[].default_value'?: unknown + + 'settings.fields[].type': string + + 'settings.fields[].validations'?: unknown + + 'settings.fields[].marketingActivityCreateUrl'?: string + + 'settings.fields[].marketingActivityDeleteUrl'?: string + + 'template.categories': string[] + + 'template.module': string + + 'template.require_app'?: boolean + + 'template.discoverable'?: boolean + + 'template.allow_one_click_activate'?: boolean + + 'template.enabled'?: boolean +} diff --git a/docs-shopify.dev/configuration/interfaces/flow-trigger-lifecycle-callback.interface.ts b/docs-shopify.dev/configuration/interfaces/flow-trigger-lifecycle-callback.interface.ts new file mode 100644 index 0000000000..31c1761603 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/flow-trigger-lifecycle-callback.interface.ts @@ -0,0 +1,6 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface flowtriggerlifecyclecallback { + 'name'?: string + + 'url'?: string +} diff --git a/docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts b/docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts new file mode 100644 index 0000000000..84893cfc56 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts @@ -0,0 +1,52 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface flowtrigger { + 'name': string + + 'type': string + + 'handle': string + + 'uid'?: string + + 'description'?: string + + 'api_version'?: string + + 'extension_points'?: unknown + + 'capabilities.network_access'?: boolean + + 'capabilities.block_progress'?: boolean + + 'capabilities.api_access'?: boolean + + 'capabilities.collect_buyer_consent.sms_marketing'?: boolean + + 'capabilities.collect_buyer_consent.customer_privacy'?: boolean + + 'capabilities.iframe.sources'?: string[] + + 'supported_features.runs_offline'?: boolean + + 'settings.fields'?: object[] + + 'settings.fields[].key'?: string + + 'settings.fields[].name'?: string + + 'settings.fields[].description'?: string + + 'settings.fields[].required'?: boolean + + 'settings.fields[].default_value'?: unknown + + 'settings.fields[].type': string + + 'settings.fields[].validations'?: unknown + + 'settings.fields[].marketingActivityCreateUrl'?: string + + 'settings.fields[].marketingActivityDeleteUrl'?: string + + 'schema'?: string +} diff --git a/docs-shopify.dev/configuration/interfaces/function.interface.ts b/docs-shopify.dev/configuration/interfaces/function.interface.ts new file mode 100644 index 0000000000..fc0fac933a --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/function.interface.ts @@ -0,0 +1,82 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface functionConfig { + 'name': string + + 'type': string + + 'handle'?: string + + 'uid'?: string + + 'description'?: string + + 'api_version': string + + 'extension_points'?: unknown + + 'capabilities.network_access'?: boolean + + 'capabilities.block_progress'?: boolean + + 'capabilities.api_access'?: boolean + + 'capabilities.collect_buyer_consent.sms_marketing'?: boolean + + 'capabilities.collect_buyer_consent.customer_privacy'?: boolean + + 'capabilities.iframe.sources'?: string[] + + 'supported_features.runs_offline'?: boolean + + 'settings.fields'?: object[] + + 'settings.fields[].key'?: string + + 'settings.fields[].name'?: string + + 'settings.fields[].description'?: string + + 'settings.fields[].required'?: boolean + + 'settings.fields[].default_value'?: unknown + + 'settings.fields[].type': string + + 'settings.fields[].validations'?: unknown + + 'settings.fields[].marketingActivityCreateUrl'?: string + + 'settings.fields[].marketingActivityDeleteUrl'?: string + + 'build.command'?: string + + 'build.path'?: string + + 'build.watch'?: string + + 'build.wasm_opt'?: boolean + + 'build.typegen_command'?: string + + 'configuration_ui'?: boolean + + 'ui.enable_create'?: boolean + + 'ui.paths.create': string + + 'ui.paths.details': string + + 'ui.handle'?: string + + 'input.variables.namespace': string + + 'input.variables.key': string + + 'targeting'?: object[] + + 'targeting[].target': string + + 'targeting[].input_query'?: string + + 'targeting[].export'?: string +} diff --git a/docs-shopify.dev/configuration/interfaces/global.interface.ts b/docs-shopify.dev/configuration/interfaces/global.interface.ts new file mode 100644 index 0000000000..7c62b97999 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/global.interface.ts @@ -0,0 +1,20 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface global { + 'client_id': string + + 'build.automatically_update_urls_on_dev'?: boolean + + 'build.dev_store_url'?: string + + 'build.include_config_on_deploy'?: boolean + + 'extension_directories'?: string[] + + 'web_directories'?: string[] + + /** The name of your app. */ + 'name': string + + /** The URL handle of your app. */ + 'handle'?: string +} diff --git a/docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts b/docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts new file mode 100644 index 0000000000..ba01fe3535 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts @@ -0,0 +1,28 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface marketingactivity { + 'name'?: string + + 'title': string + + 'description': string + + 'api_path': string + + 'tactic': 'ad' | 'retargeting' | 'post' | 'message' | 'transactional' | 'newsletter' | 'abandoned_cart' | 'affililate' | 'loyalty' | 'link' | 'storefront_app' + + 'marketing_channel': 'social' | 'search' | 'email' | 'sms' | 'display' | 'marketplace' + + 'referring_domain'?: string + + 'is_automation'?: boolean + + 'use_external_editor'?: boolean + + 'preview_data.types': object[] + + 'preview_data.types[].label': string + + 'preview_data.types[].value': string + + 'fields': object[] +} diff --git a/docs-shopify.dev/configuration/interfaces/point-of-sale.interface.ts b/docs-shopify.dev/configuration/interfaces/point-of-sale.interface.ts new file mode 100644 index 0000000000..3458da6e20 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/point-of-sale.interface.ts @@ -0,0 +1,4 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface pointofsale { + 'pos.embedded': boolean +} diff --git a/docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts b/docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts new file mode 100644 index 0000000000..c69d7ef0ec --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts @@ -0,0 +1,50 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface posuiextension { + 'name': string + + 'type'?: string + + 'handle'?: string + + 'uid'?: string + + 'description'?: string + + 'api_version'?: string + + 'extension_points'?: unknown + + 'capabilities.network_access'?: boolean + + 'capabilities.block_progress'?: boolean + + 'capabilities.api_access'?: boolean + + 'capabilities.collect_buyer_consent.sms_marketing'?: boolean + + 'capabilities.collect_buyer_consent.customer_privacy'?: boolean + + 'capabilities.iframe.sources'?: string[] + + 'supported_features.runs_offline'?: boolean + + 'settings.fields'?: object[] + + 'settings.fields[].key'?: string + + 'settings.fields[].name'?: string + + 'settings.fields[].description'?: string + + 'settings.fields[].required'?: boolean + + 'settings.fields[].default_value'?: unknown + + 'settings.fields[].type': string + + 'settings.fields[].validations'?: unknown + + 'settings.fields[].marketingActivityCreateUrl'?: string + + 'settings.fields[].marketingActivityDeleteUrl'?: string +} diff --git a/docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts b/docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts new file mode 100644 index 0000000000..1cf32177a0 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts @@ -0,0 +1,50 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface productsubscription { + 'name'?: string + + 'type'?: string + + 'handle'?: string + + 'uid'?: string + + 'description'?: string + + 'api_version'?: string + + 'extension_points'?: unknown + + 'capabilities.network_access'?: boolean + + 'capabilities.block_progress'?: boolean + + 'capabilities.api_access'?: boolean + + 'capabilities.collect_buyer_consent.sms_marketing'?: boolean + + 'capabilities.collect_buyer_consent.customer_privacy'?: boolean + + 'capabilities.iframe.sources'?: string[] + + 'supported_features.runs_offline'?: boolean + + 'settings.fields'?: object[] + + 'settings.fields[].key'?: string + + 'settings.fields[].name'?: string + + 'settings.fields[].description'?: string + + 'settings.fields[].required'?: boolean + + 'settings.fields[].default_value'?: unknown + + 'settings.fields[].type': string + + 'settings.fields[].validations'?: unknown + + 'settings.fields[].marketingActivityCreateUrl'?: string + + 'settings.fields[].marketingActivityDeleteUrl'?: string +} diff --git a/docs-shopify.dev/configuration/interfaces/subscription-link-extension.interface.ts b/docs-shopify.dev/configuration/interfaces/subscription-link-extension.interface.ts new file mode 100644 index 0000000000..27eefb1104 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/subscription-link-extension.interface.ts @@ -0,0 +1,6 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface subscriptionlinkextension { + 'pattern': string + + 'name'?: string +} diff --git a/docs-shopify.dev/configuration/interfaces/theme.interface.ts b/docs-shopify.dev/configuration/interfaces/theme.interface.ts new file mode 100644 index 0000000000..f584dc027a --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/theme.interface.ts @@ -0,0 +1,50 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface theme { + 'name'?: string + + 'type'?: string + + 'handle'?: string + + 'uid'?: string + + 'description'?: string + + 'api_version'?: string + + 'extension_points'?: unknown + + 'capabilities.network_access'?: boolean + + 'capabilities.block_progress'?: boolean + + 'capabilities.api_access'?: boolean + + 'capabilities.collect_buyer_consent.sms_marketing'?: boolean + + 'capabilities.collect_buyer_consent.customer_privacy'?: boolean + + 'capabilities.iframe.sources'?: string[] + + 'supported_features.runs_offline'?: boolean + + 'settings.fields'?: object[] + + 'settings.fields[].key'?: string + + 'settings.fields[].name'?: string + + 'settings.fields[].description'?: string + + 'settings.fields[].required'?: boolean + + 'settings.fields[].default_value'?: unknown + + 'settings.fields[].type': string + + 'settings.fields[].validations'?: unknown + + 'settings.fields[].marketingActivityCreateUrl'?: string + + 'settings.fields[].marketingActivityDeleteUrl'?: string +} diff --git a/docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts b/docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts new file mode 100644 index 0000000000..4a80738678 --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts @@ -0,0 +1,106 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface uiextension { + 'name': string + + 'type': string + + 'handle'?: string + + 'uid'?: string + + 'description'?: string + + 'api_version'?: string + + 'extension_points'?: object[] + + 'extension_points[].target': string + + 'extension_points[].module': string + + 'extension_points[].should_render.module': string + + 'extension_points[].tools'?: string + + 'extension_points[].instructions'?: string + + 'extension_points[].metafields'?: object[] + + 'extension_points[].metafields[].namespace': string + + 'extension_points[].metafields[].key': string + + 'extension_points[].default_placement'?: string + + 'extension_points[].urls.edit'?: string + + 'extension_points[].capabilities.allow_direct_linking'?: boolean + + 'extension_points[].preloads.chat'?: string + + 'capabilities.network_access'?: boolean + + 'capabilities.block_progress'?: boolean + + 'capabilities.api_access'?: boolean + + 'capabilities.collect_buyer_consent.sms_marketing'?: boolean + + 'capabilities.collect_buyer_consent.customer_privacy'?: boolean + + 'capabilities.iframe.sources'?: string[] + + 'supported_features.runs_offline'?: boolean + + 'settings.fields'?: object[] + + 'settings.fields[].key'?: string + + 'settings.fields[].name'?: string + + 'settings.fields[].description'?: string + + 'settings.fields[].required'?: boolean + + 'settings.fields[].default_value'?: unknown + + 'settings.fields[].type': string + + 'settings.fields[].validations'?: unknown + + 'settings.fields[].marketingActivityCreateUrl'?: string + + 'settings.fields[].marketingActivityDeleteUrl'?: string + + 'targeting'?: object[] + + 'targeting[].target': string + + 'targeting[].module': string + + 'targeting[].should_render.module': string + + 'targeting[].tools'?: string + + 'targeting[].instructions'?: string + + 'targeting[].metafields'?: object[] + + 'targeting[].metafields[].namespace': string + + 'targeting[].metafields[].key': string + + 'targeting[].default_placement'?: string + + 'targeting[].urls.edit'?: string + + 'targeting[].capabilities.allow_direct_linking'?: boolean + + 'targeting[].preloads.chat'?: string + + 'metafields'?: object[] + + 'metafields[].namespace': string + + 'metafields[].key': string +} diff --git a/docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts b/docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts new file mode 100644 index 0000000000..f54ce8721f --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts @@ -0,0 +1,46 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface webpixelextension { + 'name'?: string + + 'type'?: string + + 'handle'?: string + + 'uid'?: string + + 'description'?: string + + 'api_version'?: string + + 'extension_points'?: unknown + + 'capabilities.network_access'?: boolean + + 'capabilities.block_progress'?: boolean + + 'capabilities.api_access'?: boolean + + 'capabilities.collect_buyer_consent.sms_marketing'?: boolean + + 'capabilities.collect_buyer_consent.customer_privacy'?: boolean + + 'capabilities.iframe.sources'?: string[] + + 'supported_features.runs_offline'?: boolean + + 'settings'?: unknown + + 'runtime_context': string + + 'version'?: string + + 'configuration'?: unknown + + 'customer_privacy.analytics': boolean + + 'customer_privacy.preferences': boolean + + 'customer_privacy.marketing': boolean + + 'customer_privacy.sale_of_data': 'enabled' | 'disabled' | 'ldu' +} diff --git a/docs-shopify.dev/configuration/interfaces/webhook-subscription.interface.ts b/docs-shopify.dev/configuration/interfaces/webhook-subscription.interface.ts new file mode 100644 index 0000000000..9f268961bb --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/webhook-subscription.interface.ts @@ -0,0 +1,18 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface webhooksubscription { + 'topic': string + + 'actions'?: string[] + + 'api_version': string + + 'uri': string + + 'include_fields'?: string[] + + 'filter'?: string + + 'payload_query'?: string + + 'name'?: string +} diff --git a/docs-shopify.dev/configuration/interfaces/webhooks.interface.ts b/docs-shopify.dev/configuration/interfaces/webhooks.interface.ts new file mode 100644 index 0000000000..179f42442d --- /dev/null +++ b/docs-shopify.dev/configuration/interfaces/webhooks.interface.ts @@ -0,0 +1,28 @@ +// This is an autogenerated file. Don't edit this file manually. +export interface webhooks { + 'webhooks.api_version': string + + 'webhooks.privacy_compliance.customer_deletion_url'?: string + + 'webhooks.privacy_compliance.customer_data_request_url'?: string + + 'webhooks.privacy_compliance.shop_deletion_url'?: string + + 'webhooks.subscriptions'?: object[] + + 'webhooks.subscriptions[].topics'?: string[] + + 'webhooks.subscriptions[].actions'?: string[] + + 'webhooks.subscriptions[].uri': string + + 'webhooks.subscriptions[].include_fields'?: string[] + + 'webhooks.subscriptions[].filter'?: string + + 'webhooks.subscriptions[].payload_query'?: string + + 'webhooks.subscriptions[].name'?: string + + 'webhooks.subscriptions[].compliance_topics'?: string[] +} diff --git a/docs-shopify.dev/configuration/marketing-activity.doc.ts b/docs-shopify.dev/configuration/marketing-activity.doc.ts new file mode 100644 index 0000000000..464c3462cb --- /dev/null +++ b/docs-shopify.dev/configuration/marketing-activity.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Marketing Activity', + description: 'Configuration reference for Marketing Activity.', + overviewPreviewDescription: 'Marketing Activity TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/marketing-activity.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'marketingactivity', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/payments-extension.doc.ts b/docs-shopify.dev/configuration/payments-extension.doc.ts new file mode 100644 index 0000000000..30da9ecfe2 --- /dev/null +++ b/docs-shopify.dev/configuration/payments-extension.doc.ts @@ -0,0 +1,28 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Payments Extension', + description: 'Configuration reference for Payments Extension.', + overviewPreviewDescription: 'Payments Extension TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/payments-extension.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/pos-ui-extension.doc.ts b/docs-shopify.dev/configuration/pos-ui-extension.doc.ts new file mode 100644 index 0000000000..12cb94a106 --- /dev/null +++ b/docs-shopify.dev/configuration/pos-ui-extension.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'POS UI Extension', + description: 'Configuration reference for POS UI Extension.', + overviewPreviewDescription: 'POS UI Extension TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/pos-ui-extension.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'posuiextension', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/product-subscription.doc.ts b/docs-shopify.dev/configuration/product-subscription.doc.ts new file mode 100644 index 0000000000..8a73708633 --- /dev/null +++ b/docs-shopify.dev/configuration/product-subscription.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Product Subscription', + description: 'Configuration reference for Product Subscription.', + overviewPreviewDescription: 'Product Subscription TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/product-subscription.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'productsubscription', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/subscription-link-extension.doc.ts b/docs-shopify.dev/configuration/subscription-link-extension.doc.ts new file mode 100644 index 0000000000..9024dedfad --- /dev/null +++ b/docs-shopify.dev/configuration/subscription-link-extension.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Subscription Link', + description: 'Configuration reference for Subscription Link.', + overviewPreviewDescription: 'Subscription Link TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/subscription-link-extension.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'subscriptionlinkextension', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/theme.doc.ts b/docs-shopify.dev/configuration/theme.doc.ts new file mode 100644 index 0000000000..e8108d6d3a --- /dev/null +++ b/docs-shopify.dev/configuration/theme.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Online Store - App Theme Extension', + description: 'Configuration reference for Online Store - App Theme Extension.', + overviewPreviewDescription: 'Online Store - App Theme Extension TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/theme.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'theme', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/ui-extension.doc.ts b/docs-shopify.dev/configuration/ui-extension.doc.ts new file mode 100644 index 0000000000..3845913f9c --- /dev/null +++ b/docs-shopify.dev/configuration/ui-extension.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'UI Extension', + description: 'Configuration reference for UI Extension.', + overviewPreviewDescription: 'UI Extension TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/ui-extension.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'uiextension', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/web-pixel-extension.doc.ts b/docs-shopify.dev/configuration/web-pixel-extension.doc.ts new file mode 100644 index 0000000000..f808c401bb --- /dev/null +++ b/docs-shopify.dev/configuration/web-pixel-extension.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Web Pixel Extension', + description: 'Configuration reference for Web Pixel Extension.', + overviewPreviewDescription: 'Web Pixel Extension TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/web-pixel-extension.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'webpixelextension', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/configuration/webhook-subscription.doc.ts b/docs-shopify.dev/configuration/webhook-subscription.doc.ts new file mode 100644 index 0000000000..59cd6e1e21 --- /dev/null +++ b/docs-shopify.dev/configuration/webhook-subscription.doc.ts @@ -0,0 +1,33 @@ +// This is an autogenerated file. Don't edit this file manually. +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs' + +const data: ReferenceEntityTemplateSchema = { + name: 'Webhooks Subscriptions', + description: 'Configuration reference for Webhooks Subscriptions.', + overviewPreviewDescription: 'Webhooks Subscriptions TOML configuration.', + type: 'resource', + isVisualComponent: false, + defaultExample: { + codeblock: { + tabs: [ + { + title: 'shopify.extension.toml', + code: './examples/webhook-subscription.example.toml', + language: 'toml', + }, + ], + title: 'Example configuration', + }, + }, + definitions: [ + { + title: 'Properties', + description: 'The following properties are available:', + type: 'webhooksubscription', + }, + ], + category: 'extension-configuration', + related: [], +} + +export default data \ No newline at end of file diff --git a/docs-shopify.dev/generated/generated_docs_data.json b/docs-shopify.dev/generated/generated_docs_data.json index 8dd1835d1d..c4dea78269 100644 --- a/docs-shopify.dev/generated/generated_docs_data.json +++ b/docs-shopify.dev/generated/generated_docs_data.json @@ -8022,5 +8022,4427 @@ "definitions": [], "category": "general commands", "related": [] + }, + { + "name": "Admin Link", + "description": "Configuration reference for Admin Link.", + "overviewPreviewDescription": "Admin Link TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Admin Link\"\ntype = \"admin_link\"\n\ndescription = \"example\"\n[[targeting]]\nurl = \"example\"\ntarget = \"admin.abandoned-checkout-details.action.link\"\ntools = \"example\"\ninstructions = \"example\"\n[targeting.build_manifest]\n[targeting.build_manifest.assets]\n[targeting.build_manifest.assets.tools]\nfilepath = \"example\"\nmodule = \"example\"\nstatic = true\n\n[targeting.build_manifest.assets.instructions]\nfilepath = \"example\"\nmodule = \"example\"\nstatic = true\n\n[[targeting.build_manifest.assets.intents]]\nfilepath = \"example\"\nmodule = \"example\"\nstatic = true\n\n\n\n[[targeting.intents]]\naction = \"example\"\ntype = \"example\"\nschema = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "adminlink", + "typeDefinitions": { + "adminlink": { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "name": "adminlink", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "Description of the link", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "localization", + "value": "object", + "description": "Localization of the link text", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "Text to be displayed on the surface" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting", + "value": "object[]", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].build_manifest.assets.instructions.filepath", + "value": "string", + "description": "Path to the schema file to upload" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].build_manifest.assets.instructions.module", + "value": "string", + "description": "Module reference for the schema" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].build_manifest.assets.instructions.static", + "value": "boolean", + "description": "Whether the asset is static", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].build_manifest.assets.intents", + "value": "object[]", + "description": "Schema files for intents", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].build_manifest.assets.intents[].filepath", + "value": "string", + "description": "Path to the schema file to upload" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].build_manifest.assets.intents[].module", + "value": "string", + "description": "Module reference for the schema" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].build_manifest.assets.intents[].static", + "value": "boolean", + "description": "Whether the asset is static", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].build_manifest.assets.tools.filepath", + "value": "string", + "description": "Path to the schema file to upload" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].build_manifest.assets.tools.module", + "value": "string", + "description": "Module reference for the schema" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].build_manifest.assets.tools.static", + "value": "boolean", + "description": "Whether the asset is static", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].instructions", + "value": "string", + "description": "Instructions markdown file", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].intents", + "value": "object[]", + "description": "App intents configuration for admin.app.intent.render target", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].intents[].action", + "value": "string", + "description": "The intent action identifier" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].intents[].schema", + "value": "string", + "description": "Module reference for the schema" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].intents[].type", + "value": "string", + "description": "The intent type" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].target", + "value": "\"admin.abandoned-checkout-details.action.link\" | \"admin.discount-index.action.link\" | \"admin.discount-index.selection-action.link\" | \"admin.discount-details.action.link\" | \"admin.customer-index.action.link\" | \"admin.customer-index.selection-action.link\" | \"admin.customer-details.action.link\" | \"admin.order-index.action.link\" | \"admin.order-index.selection-action.link\" | \"admin.order-details.action.link\" | \"admin.draft-order-details.action.link\" | \"admin.draft-order-index.action.link\" | \"admin.draft-order-index.selection-action.link\" | \"admin.product-index.action.link\" | \"admin.product-index.selection-action.link\" | \"admin.product-details.action.link\" | \"admin.product-variant-details.action.link\" | \"admin.product-variant-index.selection-action.link\" | \"admin.collection-details.action.link\" | \"admin.collection-index.action.link\" | \"admin.order-fulfilled-card.action.link\" | \"admin.app.support.link\" | \"admin.page-index.action.link\" | \"admin.page-details.action.link\" | \"admin.blog-details.action.link\" | \"admin.article-details.action.link\" | \"admin.app.intent.link\"", + "description": "Target in the surface where the link will be rendered" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].tools", + "value": "string", + "description": "Tools JSON schema", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].url", + "value": "string", + "description": "URL or app path to be navigated to when the link is clicked" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/admin-link.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uploaded_files", + "value": "object", + "description": "Uploaded files for the module", + "isOptional": true + } + ], + "value": "export interface adminlink {\n /** Text to be displayed on the surface */\n 'name': string\n\n /** Description of the link */\n 'description'?: string\n\n 'targeting': object[]\n\n /** URL or app path to be navigated to when the link is clicked */\n 'targeting[].url': string\n\n /** Target in the surface where the link will be rendered */\n 'targeting[].target': 'admin.abandoned-checkout-details.action.link' | 'admin.discount-index.action.link' | 'admin.discount-index.selection-action.link' | 'admin.discount-details.action.link' | 'admin.customer-index.action.link' | 'admin.customer-index.selection-action.link' | 'admin.customer-details.action.link' | 'admin.order-index.action.link' | 'admin.order-index.selection-action.link' | 'admin.order-details.action.link' | 'admin.draft-order-details.action.link' | 'admin.draft-order-index.action.link' | 'admin.draft-order-index.selection-action.link' | 'admin.product-index.action.link' | 'admin.product-index.selection-action.link' | 'admin.product-details.action.link' | 'admin.product-variant-details.action.link' | 'admin.product-variant-index.selection-action.link' | 'admin.collection-details.action.link' | 'admin.collection-index.action.link' | 'admin.order-fulfilled-card.action.link' | 'admin.app.support.link' | 'admin.page-index.action.link' | 'admin.page-details.action.link' | 'admin.blog-details.action.link' | 'admin.article-details.action.link' | 'admin.app.intent.link'\n\n /** App intents configuration for admin.app.intent.render target */\n 'targeting[].intents'?: object[]\n\n /** The intent action identifier */\n 'targeting[].intents[].action': string\n\n /** The intent type */\n 'targeting[].intents[].type': string\n\n /** Module reference for the schema */\n 'targeting[].intents[].schema': string\n\n /** Tools JSON schema */\n 'targeting[].tools'?: string\n\n /** Instructions markdown file */\n 'targeting[].instructions'?: string\n\n /** Schema files for intents */\n 'targeting[].build_manifest.assets.intents'?: object[]\n\n /** Path to the schema file to upload */\n 'targeting[].build_manifest.assets.intents[].filepath': string\n\n /** Module reference for the schema */\n 'targeting[].build_manifest.assets.intents[].module': string\n\n /** Whether the asset is static */\n 'targeting[].build_manifest.assets.intents[].static'?: boolean\n\n /** Path to the schema file to upload */\n 'targeting[].build_manifest.assets.tools.filepath': string\n\n /** Module reference for the schema */\n 'targeting[].build_manifest.assets.tools.module': string\n\n /** Whether the asset is static */\n 'targeting[].build_manifest.assets.tools.static'?: boolean\n\n /** Path to the schema file to upload */\n 'targeting[].build_manifest.assets.instructions.filepath': string\n\n /** Module reference for the schema */\n 'targeting[].build_manifest.assets.instructions.module': string\n\n /** Whether the asset is static */\n 'targeting[].build_manifest.assets.instructions.static'?: boolean\n\n /** Localization of the link text */\n 'localization'?: object\n\n /** Uploaded files for the module */\n 'uploaded_files'?: object\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "App configuration", + "description": "Reference for the shopify.app.toml configuration file.", + "overviewPreviewDescription": "shopify.app.toml configuration reference.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.app.toml", + "code": "# Global\nclient_id = \"example\"\nextension_directories = [\"example\"]\nweb_directories = [\"example\"]\nname = \"example\"\nhandle = \"example\"\n[build]\nautomatically_update_urls_on_dev = true\ndev_store_url = \"example\"\ninclude_config_on_deploy = true\n\n\n# App access\n[access]\n[access.admin]\ndirect_api_mode = \"online\"\nembedded_app_direct_api_access = true\n\n\n[access_scopes]\nscopes = \"example\"\nrequired_scopes = [\"example\"]\noptional_scopes = [\"example\"]\nuse_legacy_install_flow = true\n\n[auth]\nredirect_urls = [\"example\"]\n\n\n# Imperative Webhooks Api Version\n[webhooks]\napi_version = \"example\"\n[webhooks.privacy_compliance]\ncustomer_deletion_url = \"example\"\ncustomer_data_request_url = \"example\"\nshop_deletion_url = \"example\"\n\n[[webhooks.subscriptions]]\ntopics = [\"example\"]\nactions = [\"example\"]\nuri = \"example\"\ninclude_fields = [\"example\"]\nfilter = \"example\"\npayload_query = \"example\"\nname = \"example\"\ncompliance_topics = [\"example\"]\n\n\n\n# App Proxy\n[app_proxy]\nurl = \"example\"\nsubpath = \"example\"\nprefix = \"example\"\n\n\n# Point Of Sale Configuration\n[pos]\nembedded = true\n\n\n# App Home\napplication_url = \"example\"\nembedded = true\n[app_preferences]\nurl = \"example\"\n\n\n# Channel Configuration\ncreate_legacy_channel_on_app_install = true\n\n# Customer Authentication\n[customer_authentication]\nredirect_uris = [\"example\"]\njavascript_origins = [\"example\"]\nlogout_urls = [\"example\"]\n\n\n# Custom data\n[metafields]\napi_version = \"2025-04\"\n\n[company]\n[company.metafields]\n\n\n[company_location]\n[company_location.metafields]\n\n\n[payment_customization]\n[payment_customization.metafields]\n\n\n[validation]\n[validation.metafields]\n\n\n[customer]\n[customer.metafields]\nstandard_metafields = [\"example\"]\n\n\n[delivery_customization]\n[delivery_customization.metafields]\n\n\n[draft_order]\n[draft_order.metafields]\n\n\n[gift_card_transaction]\n[gift_card_transaction.metafields]\n\n\n[market]\n[market.metafields]\n\n\n[cart_transform]\n[cart_transform.metafields]\n\n\n[collection]\n[collection.metafields]\n\n\n[product]\n[product.metafields]\nstandard_metafields = [\"example\"]\n\n\n[variant]\n[variant.metafields]\nstandard_metafields = [\"example\"]\n\n\n[selling_plan]\n[selling_plan.metafields]\n\n\n[article]\n[article.metafields]\n\n\n[blog]\n[blog.metafields]\n\n\n[page]\n[page.metafields]\n\n\n[fulfillment_constraint_rule]\n[fulfillment_constraint_rule.metafields]\n\n\n[order_routing_location_rule]\n[order_routing_location_rule.metafields]\n\n\n[discount]\n[discount.metafields]\n\n\n[order]\n[order.metafields]\n\n\n[location]\n[location.metafields]\n\n\n[shop]\n[shop.metafields]\n\n\n[delivery_method]\n[delivery_method.metafields]\n\n\n[delivery_option_generator]\n[delivery_option_generator.metafields]\n\n\n[metaobjects]\nstandard_metaobjects = [\"example\"]\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Global", + "description": "Global properties.", + "type": "global", + "typeDefinitions": { + "global": { + "filePath": "docs-shopify.dev/configuration/interfaces/global.interface.ts", + "name": "global", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/global.interface.ts", + "syntaxKind": "PropertySignature", + "name": "build.automatically_update_urls_on_dev", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/global.interface.ts", + "syntaxKind": "PropertySignature", + "name": "build.dev_store_url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/global.interface.ts", + "syntaxKind": "PropertySignature", + "name": "build.include_config_on_deploy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/global.interface.ts", + "syntaxKind": "PropertySignature", + "name": "client_id", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/global.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_directories", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/global.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The URL handle of your app.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/global.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name of your app." + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/global.interface.ts", + "syntaxKind": "PropertySignature", + "name": "web_directories", + "value": "string[]", + "description": "", + "isOptional": true + } + ], + "value": "export interface global {\n 'client_id': string\n\n 'build.automatically_update_urls_on_dev'?: boolean\n\n 'build.dev_store_url'?: string\n\n 'build.include_config_on_deploy'?: boolean\n\n 'extension_directories'?: string[]\n\n 'web_directories'?: string[]\n\n /** The name of your app. */\n 'name': string\n\n /** The URL handle of your app. */\n 'handle'?: string\n}" + } + } + }, + { + "title": "App access", + "description": "App access properties.", + "type": "appaccess", + "typeDefinitions": { + "appaccess": { + "filePath": "docs-shopify.dev/configuration/interfaces/app-access.interface.ts", + "name": "appaccess", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-access.interface.ts", + "syntaxKind": "PropertySignature", + "name": "access_scopes.optional_scopes", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-access.interface.ts", + "syntaxKind": "PropertySignature", + "name": "access_scopes.required_scopes", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-access.interface.ts", + "syntaxKind": "PropertySignature", + "name": "access_scopes.scopes", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-access.interface.ts", + "syntaxKind": "PropertySignature", + "name": "access_scopes.use_legacy_install_flow", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-access.interface.ts", + "syntaxKind": "PropertySignature", + "name": "access.admin.direct_api_mode", + "value": "\"offline\" | \"online\"", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-access.interface.ts", + "syntaxKind": "PropertySignature", + "name": "access.admin.embedded_app_direct_api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-access.interface.ts", + "syntaxKind": "PropertySignature", + "name": "auth.redirect_urls", + "value": "string[]", + "description": "" + } + ], + "value": "export interface appaccess {\n 'access.admin.direct_api_mode'?: 'online' | 'offline'\n\n 'access.admin.embedded_app_direct_api_access'?: boolean\n\n 'access_scopes.scopes'?: string\n\n 'access_scopes.required_scopes'?: string[]\n\n 'access_scopes.optional_scopes'?: string[]\n\n 'access_scopes.use_legacy_install_flow'?: boolean\n\n 'auth.redirect_urls': string[]\n}" + } + } + }, + { + "title": "Imperative Webhooks Api Version", + "description": "Imperative Webhooks Api Version properties.", + "type": "webhooks", + "typeDefinitions": { + "webhooks": { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "name": "webhooks", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.api_version", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.privacy_compliance.customer_data_request_url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.privacy_compliance.customer_deletion_url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.privacy_compliance.shop_deletion_url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.subscriptions", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.subscriptions[].actions", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.subscriptions[].compliance_topics", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.subscriptions[].filter", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.subscriptions[].include_fields", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.subscriptions[].name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.subscriptions[].payload_query", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.subscriptions[].topics", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhooks.interface.ts", + "syntaxKind": "PropertySignature", + "name": "webhooks.subscriptions[].uri", + "value": "string", + "description": "" + } + ], + "value": "export interface webhooks {\n 'webhooks.api_version': string\n\n 'webhooks.privacy_compliance.customer_deletion_url'?: string\n\n 'webhooks.privacy_compliance.customer_data_request_url'?: string\n\n 'webhooks.privacy_compliance.shop_deletion_url'?: string\n\n 'webhooks.subscriptions'?: object[]\n\n 'webhooks.subscriptions[].topics'?: string[]\n\n 'webhooks.subscriptions[].actions'?: string[]\n\n 'webhooks.subscriptions[].uri': string\n\n 'webhooks.subscriptions[].include_fields'?: string[]\n\n 'webhooks.subscriptions[].filter'?: string\n\n 'webhooks.subscriptions[].payload_query'?: string\n\n 'webhooks.subscriptions[].name'?: string\n\n 'webhooks.subscriptions[].compliance_topics'?: string[]\n}" + } + } + }, + { + "title": "App Proxy", + "description": "App Proxy properties.", + "type": "appproxy", + "typeDefinitions": { + "appproxy": { + "filePath": "docs-shopify.dev/configuration/interfaces/app-proxy.interface.ts", + "name": "appproxy", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-proxy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "app_proxy.prefix", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-proxy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "app_proxy.subpath", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-proxy.interface.ts", + "syntaxKind": "PropertySignature", + "name": "app_proxy.url", + "value": "string", + "description": "" + } + ], + "value": "export interface appproxy {\n 'app_proxy.url': string\n\n 'app_proxy.subpath': string\n\n 'app_proxy.prefix': string\n}" + } + } + }, + { + "title": "Point Of Sale Configuration", + "description": "Point Of Sale Configuration properties.", + "type": "pointofsale", + "typeDefinitions": { + "pointofsale": { + "filePath": "docs-shopify.dev/configuration/interfaces/point-of-sale.interface.ts", + "name": "pointofsale", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/point-of-sale.interface.ts", + "syntaxKind": "PropertySignature", + "name": "pos.embedded", + "value": "boolean", + "description": "" + } + ], + "value": "export interface pointofsale {\n 'pos.embedded': boolean\n}" + } + } + }, + { + "title": "App Home", + "description": "App Home properties.", + "type": "apphome", + "typeDefinitions": { + "apphome": { + "filePath": "docs-shopify.dev/configuration/interfaces/app-home.interface.ts", + "name": "apphome", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-home.interface.ts", + "syntaxKind": "PropertySignature", + "name": "app_preferences.url", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-home.interface.ts", + "syntaxKind": "PropertySignature", + "name": "application_url", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/app-home.interface.ts", + "syntaxKind": "PropertySignature", + "name": "embedded", + "value": "boolean", + "description": "" + } + ], + "value": "export interface apphome {\n 'application_url': string\n\n 'embedded': boolean\n\n 'app_preferences.url': string\n}" + } + } + }, + { + "title": "Channel Configuration", + "description": "Channel Configuration properties.", + "type": "channelconfig", + "typeDefinitions": { + "channelconfig": { + "filePath": "docs-shopify.dev/configuration/interfaces/channel-config.interface.ts", + "name": "channelconfig", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/channel-config.interface.ts", + "syntaxKind": "PropertySignature", + "name": "create_legacy_channel_on_app_install", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/channel-config.interface.ts", + "syntaxKind": "PropertySignature", + "name": "specifications", + "value": "object", + "description": "", + "isOptional": true + } + ], + "value": "export interface channelconfig {\n 'specifications'?: object\n\n 'create_legacy_channel_on_app_install'?: boolean\n}" + } + } + }, + { + "title": "Customer Authentication", + "description": "Customer Authentication properties.", + "type": "customerauthentication", + "typeDefinitions": { + "customerauthentication": { + "filePath": "docs-shopify.dev/configuration/interfaces/customer-authentication.interface.ts", + "name": "customerauthentication", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/customer-authentication.interface.ts", + "syntaxKind": "PropertySignature", + "name": "customer_authentication.javascript_origins", + "value": "string[]", + "description": "JavaScript origins for customer authentication (scheme and host only, no paths or ports)", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/customer-authentication.interface.ts", + "syntaxKind": "PropertySignature", + "name": "customer_authentication.logout_urls", + "value": "string[]", + "description": "Logout URLs for customer authentication", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/customer-authentication.interface.ts", + "syntaxKind": "PropertySignature", + "name": "customer_authentication.redirect_uris", + "value": "string[]", + "description": "Redirect URIs used for authentication flows" + } + ], + "value": "export interface customerauthentication {\n /** Redirect URIs used for authentication flows */\n 'customer_authentication.redirect_uris': string[]\n\n /** JavaScript origins for customer authentication (scheme and host only, no paths or ports) */\n 'customer_authentication.javascript_origins'?: string[]\n\n /** Logout URLs for customer authentication */\n 'customer_authentication.logout_urls'?: string[]\n}" + } + } + }, + { + "title": "Custom data", + "description": "Custom data properties.", + "type": "data", + "typeDefinitions": { + "data": { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "name": "data", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "article.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "blog.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "cart_transform.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "collection.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "company_location.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "company.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "customer.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "customer.metafields.standard_metafields", + "value": "string[]", + "description": "Array of standard metafield definition templates to enable. Each identifier is in the format 'namespace.key' (e.g. 'facts.isbn', 'reviews.rating'). These are pre-defined metafield definitions provided by Shopify.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "delivery_customization.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "delivery_method.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "delivery_option_generator.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "discount.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "draft_order.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "fulfillment_constraint_rule.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "gift_card_transaction.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "location.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "market.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "metafields.api_version", + "value": "\"2025-04\" | \"2025-07\" | \"2025-10\" | \"2026-01\" | \"2026-04\" | \"unstable\"", + "description": "The Admin API lets you build apps and integrations that extend and enhance the Shopify admin." + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "metaobjects.app", + "value": "object", + "description": "Each entry here represents a metaobject definition. For instance, `[metaobjects.app.author]` becomes a metaobject definition of type `$app:author`." + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "metaobjects.standard_metaobjects", + "value": "string[]", + "description": "Array of standard metaobject definition templates to enable (e.g. 'shopify--qa-pair'). These are pre-defined metaobject definitions provided by Shopify.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "order_routing_location_rule.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "order.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "page.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "payment_customization.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "product.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "product.metafields.standard_metafields", + "value": "string[]", + "description": "Array of standard metafield definition templates to enable. Each identifier is in the format 'namespace.key' (e.g. 'facts.isbn', 'reviews.rating'). These are pre-defined metafield definitions provided by Shopify.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "selling_plan.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "shop.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "validation.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "variant.metafields.app", + "value": "object", + "description": "A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace.", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/data.interface.ts", + "syntaxKind": "PropertySignature", + "name": "variant.metafields.standard_metafields", + "value": "string[]", + "description": "Array of standard metafield definition templates to enable. Each identifier is in the format 'namespace.key' (e.g. 'facts.isbn', 'reviews.rating'). These are pre-defined metafield definitions provided by Shopify.", + "isOptional": true + } + ], + "value": "export interface data {\n /** The Admin API lets you build apps and integrations that extend and enhance the Shopify admin. */\n 'metafields.api_version': '2025-04' | '2025-07' | '2025-10' | '2026-01' | '2026-04' | 'unstable'\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'company.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'company_location.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'payment_customization.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'validation.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'customer.metafields.app'?: object\n\n /** Array of standard metafield definition templates to enable. Each identifier is in the format 'namespace.key' (e.g. 'facts.isbn', 'reviews.rating'). These are pre-defined metafield definitions provided by Shopify. */\n 'customer.metafields.standard_metafields'?: string[]\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'delivery_customization.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'draft_order.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'gift_card_transaction.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'market.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'cart_transform.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'collection.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'product.metafields.app'?: object\n\n /** Array of standard metafield definition templates to enable. Each identifier is in the format 'namespace.key' (e.g. 'facts.isbn', 'reviews.rating'). These are pre-defined metafield definitions provided by Shopify. */\n 'product.metafields.standard_metafields'?: string[]\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'variant.metafields.app'?: object\n\n /** Array of standard metafield definition templates to enable. Each identifier is in the format 'namespace.key' (e.g. 'facts.isbn', 'reviews.rating'). These are pre-defined metafield definitions provided by Shopify. */\n 'variant.metafields.standard_metafields'?: string[]\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'selling_plan.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'article.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'blog.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'page.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'fulfillment_constraint_rule.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'order_routing_location_rule.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'discount.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'order.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'location.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'shop.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'delivery_method.metafields.app'?: object\n\n /** A namespace for metafields. `.app` places metafields under the `$app` namespace; `.other` places metafields under the `$app:other` namespace. */\n 'delivery_option_generator.metafields.app'?: object\n\n /** Each entry here represents a metaobject definition. For instance, `[metaobjects.app.author]` becomes a metaobject definition of type `$app:author`. */\n 'metaobjects.app': object\n\n /** Array of standard metaobject definition templates to enable (e.g. 'shopify--qa-pair'). These are pre-defined metaobject definitions provided by Shopify. */\n 'metaobjects.standard_metaobjects'?: string[]\n}" + } + } + } + ], + "category": "app-configuration", + "related": [] + }, + { + "name": "Checkout Post Purchase", + "description": "Configuration reference for Checkout Post Purchase.", + "overviewPreviewDescription": "Checkout Post Purchase TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Checkout Post Purchase\"\ntype = \"checkout_post_purchase\"\n\nuid = \"example\"\ndescription = \"example\"\napi_version = \"example\"\nextension_points = \"example\"\n[capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n[capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[capabilities.iframe]\nsources = [\"example\"]\n\n\n[supported_features]\nruns_offline = true\n\n[settings]\n[[settings.fields]]\nkey = \"example\"\nname = \"example\"\ndescription = \"example\"\nrequired = true\ndefault_value = \"example\"\ntype = \"example\"\nvalidations = \"example\"\nmarketingActivityCreateUrl = \"example\"\nmarketingActivityDeleteUrl = \"example\"\n\n\n[[metafields]]\nnamespace = \"example\"\nkey = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "checkoutpostpurchase", + "typeDefinitions": { + "checkoutpostpurchase": { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "name": "checkoutpostpurchase", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.block_progress", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.customer_privacy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.sms_marketing", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.iframe.sources", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.network_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "metafields[].key", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "metafields[].namespace", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].default_value", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].key", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityCreateUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityDeleteUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].required", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].validations", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "supported_features.runs_offline", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-post-purchase.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uid", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface checkoutpostpurchase {\n 'name'?: string\n\n 'type'?: string\n\n 'handle'?: string\n\n 'uid'?: string\n\n 'description'?: string\n\n 'api_version'?: string\n\n 'extension_points'?: unknown\n\n 'capabilities.network_access'?: boolean\n\n 'capabilities.block_progress'?: boolean\n\n 'capabilities.api_access'?: boolean\n\n 'capabilities.collect_buyer_consent.sms_marketing'?: boolean\n\n 'capabilities.collect_buyer_consent.customer_privacy'?: boolean\n\n 'capabilities.iframe.sources'?: string[]\n\n 'supported_features.runs_offline'?: boolean\n\n 'settings.fields'?: object[]\n\n 'settings.fields[].key'?: string\n\n 'settings.fields[].name'?: string\n\n 'settings.fields[].description'?: string\n\n 'settings.fields[].required'?: boolean\n\n 'settings.fields[].default_value'?: unknown\n\n 'settings.fields[].type': string\n\n 'settings.fields[].validations'?: unknown\n\n 'settings.fields[].marketingActivityCreateUrl'?: string\n\n 'settings.fields[].marketingActivityDeleteUrl'?: string\n\n 'metafields'?: object[]\n\n 'metafields[].namespace': string\n\n 'metafields[].key': string\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Checkout Extension", + "description": "Configuration reference for Checkout Extension.", + "overviewPreviewDescription": "Checkout Extension TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Checkout Extension\"\ntype = \"checkout_ui_extension\"\n\nuid = \"example\"\ndescription = \"example\"\napi_version = \"example\"\nextension_points = [\"example\"]\n[capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n[capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[capabilities.iframe]\nsources = [\"example\"]\n\n\n[supported_features]\nruns_offline = true\n\n[settings]\nfields = \"example\"\n\n[[metafields]]\nnamespace = \"example\"\nkey = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "checkoutuiextension", + "typeDefinitions": { + "checkoutuiextension": { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "name": "checkoutuiextension", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.block_progress", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.customer_privacy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.sms_marketing", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.iframe.sources", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.network_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "metafields[].key", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "metafields[].namespace", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "supported_features.runs_offline", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/checkout-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uid", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface checkoutuiextension {\n 'name': string\n\n 'type'?: string\n\n 'handle'?: string\n\n 'uid'?: string\n\n 'description'?: string\n\n 'api_version'?: string\n\n 'extension_points'?: string[]\n\n 'capabilities.network_access'?: boolean\n\n 'capabilities.block_progress'?: boolean\n\n 'capabilities.api_access'?: boolean\n\n 'capabilities.collect_buyer_consent.sms_marketing'?: boolean\n\n 'capabilities.collect_buyer_consent.customer_privacy'?: boolean\n\n 'capabilities.iframe.sources'?: string[]\n\n 'supported_features.runs_offline'?: boolean\n\n 'settings.fields'?: unknown\n\n 'metafields'?: object[]\n\n 'metafields[].namespace': string\n\n 'metafields[].key': string\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Editor extension collection", + "description": "Configuration reference for Editor extension collection.", + "overviewPreviewDescription": "Editor extension collection TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Editor extension collection\"\ntype = \"editor_extension_collection\"\n\nuid = \"example\"\ndescription = \"example\"\napi_version = \"example\"\nextension_points = \"example\"\nincludes = [\"example\"]\n[capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n[capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[capabilities.iframe]\nsources = [\"example\"]\n\n\n[supported_features]\nruns_offline = true\n\n[settings]\n[[settings.fields]]\nkey = \"example\"\nname = \"example\"\ndescription = \"example\"\nrequired = true\ndefault_value = \"example\"\ntype = \"example\"\nvalidations = \"example\"\nmarketingActivityCreateUrl = \"example\"\nmarketingActivityDeleteUrl = \"example\"\n\n\n[[include]]\nhandle = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "editorextensioncollection", + "typeDefinitions": { + "editorextensioncollection": { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "name": "editorextensioncollection", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.block_progress", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.customer_privacy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.sms_marketing", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.iframe.sources", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.network_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "include", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "include[].handle", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "includes", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].default_value", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].key", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityCreateUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityDeleteUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].required", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].validations", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "supported_features.runs_offline", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/editor-extension-collection.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uid", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface editorextensioncollection {\n 'name': string\n\n 'type': string\n\n 'handle'?: string\n\n 'uid'?: string\n\n 'description'?: string\n\n 'api_version'?: string\n\n 'extension_points'?: unknown\n\n 'capabilities.network_access'?: boolean\n\n 'capabilities.block_progress'?: boolean\n\n 'capabilities.api_access'?: boolean\n\n 'capabilities.collect_buyer_consent.sms_marketing'?: boolean\n\n 'capabilities.collect_buyer_consent.customer_privacy'?: boolean\n\n 'capabilities.iframe.sources'?: string[]\n\n 'supported_features.runs_offline'?: boolean\n\n 'settings.fields'?: object[]\n\n 'settings.fields[].key'?: string\n\n 'settings.fields[].name'?: string\n\n 'settings.fields[].description'?: string\n\n 'settings.fields[].required'?: boolean\n\n 'settings.fields[].default_value'?: unknown\n\n 'settings.fields[].type': string\n\n 'settings.fields[].validations'?: unknown\n\n 'settings.fields[].marketingActivityCreateUrl'?: string\n\n 'settings.fields[].marketingActivityDeleteUrl'?: string\n\n 'include'?: object[]\n\n 'include[].handle': string\n\n 'includes'?: string[]\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Flow Action", + "description": "Configuration reference for Flow Action.", + "overviewPreviewDescription": "Flow Action TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Flow Action\"\ntype = \"flow_action\"\n\nuid = \"example\"\ndescription = \"example\"\napi_version = \"example\"\nextension_points = \"example\"\nruntime_url = \"example\"\nvalidation_url = \"example\"\nconfig_page_url = \"example\"\nconfig_page_preview_url = \"example\"\nschema = \"example\"\nreturn_type_ref = \"example\"\n[capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n[capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[capabilities.iframe]\nsources = [\"example\"]\n\n\n[supported_features]\nruns_offline = true\n\n[settings]\n[[settings.fields]]\nkey = \"example\"\nname = \"example\"\ndescription = \"example\"\nrequired = true\ndefault_value = \"example\"\ntype = \"example\"\nvalidations = \"example\"\nmarketingActivityCreateUrl = \"example\"\nmarketingActivityDeleteUrl = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "flowaction", + "typeDefinitions": { + "flowaction": { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "name": "flowaction", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.block_progress", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.customer_privacy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.sms_marketing", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.iframe.sources", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.network_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "config_page_preview_url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "config_page_url", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "return_type_ref", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "runtime_url", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "schema", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].default_value", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].key", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityCreateUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityDeleteUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].required", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].validations", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "supported_features.runs_offline", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uid", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-action.interface.ts", + "syntaxKind": "PropertySignature", + "name": "validation_url", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface flowaction {\n 'name': string\n\n 'type': string\n\n 'handle': string\n\n 'uid'?: string\n\n 'description'?: string\n\n 'api_version'?: string\n\n 'extension_points'?: unknown\n\n 'capabilities.network_access'?: boolean\n\n 'capabilities.block_progress'?: boolean\n\n 'capabilities.api_access'?: boolean\n\n 'capabilities.collect_buyer_consent.sms_marketing'?: boolean\n\n 'capabilities.collect_buyer_consent.customer_privacy'?: boolean\n\n 'capabilities.iframe.sources'?: string[]\n\n 'supported_features.runs_offline'?: boolean\n\n 'settings.fields'?: object[]\n\n 'settings.fields[].key'?: string\n\n 'settings.fields[].name'?: string\n\n 'settings.fields[].description'?: string\n\n 'settings.fields[].required'?: boolean\n\n 'settings.fields[].default_value'?: unknown\n\n 'settings.fields[].type': string\n\n 'settings.fields[].validations'?: unknown\n\n 'settings.fields[].marketingActivityCreateUrl'?: string\n\n 'settings.fields[].marketingActivityDeleteUrl'?: string\n\n 'runtime_url': string\n\n 'validation_url'?: string\n\n 'config_page_url'?: string\n\n 'config_page_preview_url'?: string\n\n 'schema'?: string\n\n 'return_type_ref'?: string\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Flow Template", + "description": "Configuration reference for Flow Template.", + "overviewPreviewDescription": "Flow Template TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Flow Template\"\ntype = \"flow_template\"\n\nuid = \"example\"\ndescription = \"example\"\napi_version = \"example\"\nextension_points = \"example\"\n[capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n[capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[capabilities.iframe]\nsources = [\"example\"]\n\n\n[supported_features]\nruns_offline = true\n\n[settings]\n[[settings.fields]]\nkey = \"example\"\nname = \"example\"\ndescription = \"example\"\nrequired = true\ndefault_value = \"example\"\ntype = \"example\"\nvalidations = \"example\"\nmarketingActivityCreateUrl = \"example\"\nmarketingActivityDeleteUrl = \"example\"\n\n\n[template]\ncategories = [\"example\"]\nmodule = \"example\"\nrequire_app = true\ndiscoverable = true\nallow_one_click_activate = true\nenabled = true\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "flowtemplate", + "typeDefinitions": { + "flowtemplate": { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "name": "flowtemplate", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.block_progress", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.customer_privacy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.sms_marketing", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.iframe.sources", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.network_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].default_value", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].key", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityCreateUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityDeleteUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].required", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].validations", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "supported_features.runs_offline", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "template.allow_one_click_activate", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "template.categories", + "value": "string[]", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "template.discoverable", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "template.enabled", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "template.module", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "template.require_app", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-template.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uid", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface flowtemplate {\n 'name': string\n\n 'type': string\n\n 'handle': string\n\n 'uid'?: string\n\n 'description': string\n\n 'api_version'?: string\n\n 'extension_points'?: unknown\n\n 'capabilities.network_access'?: boolean\n\n 'capabilities.block_progress'?: boolean\n\n 'capabilities.api_access'?: boolean\n\n 'capabilities.collect_buyer_consent.sms_marketing'?: boolean\n\n 'capabilities.collect_buyer_consent.customer_privacy'?: boolean\n\n 'capabilities.iframe.sources'?: string[]\n\n 'supported_features.runs_offline'?: boolean\n\n 'settings.fields'?: object[]\n\n 'settings.fields[].key'?: string\n\n 'settings.fields[].name'?: string\n\n 'settings.fields[].description'?: string\n\n 'settings.fields[].required'?: boolean\n\n 'settings.fields[].default_value'?: unknown\n\n 'settings.fields[].type': string\n\n 'settings.fields[].validations'?: unknown\n\n 'settings.fields[].marketingActivityCreateUrl'?: string\n\n 'settings.fields[].marketingActivityDeleteUrl'?: string\n\n 'template.categories': string[]\n\n 'template.module': string\n\n 'template.require_app'?: boolean\n\n 'template.discoverable'?: boolean\n\n 'template.allow_one_click_activate'?: boolean\n\n 'template.enabled'?: boolean\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Flow Trigger Lifecycle Callback", + "description": "Configuration reference for Flow Trigger Lifecycle Callback.", + "overviewPreviewDescription": "Flow Trigger Lifecycle Callback TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Flow Trigger Lifecycle Callback\"\ntype = \"flow_trigger_lifecycle_callback\"\n\nurl = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "flowtriggerlifecyclecallback", + "typeDefinitions": { + "flowtriggerlifecyclecallback": { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger-lifecycle-callback.interface.ts", + "name": "flowtriggerlifecyclecallback", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger-lifecycle-callback.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger-lifecycle-callback.interface.ts", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface flowtriggerlifecyclecallback {\n 'name'?: string\n\n 'url'?: string\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Flow Trigger", + "description": "Configuration reference for Flow Trigger.", + "overviewPreviewDescription": "Flow Trigger TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Flow Trigger\"\ntype = \"flow_trigger\"\n\nuid = \"example\"\ndescription = \"example\"\napi_version = \"example\"\nextension_points = \"example\"\nschema = \"example\"\n[capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n[capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[capabilities.iframe]\nsources = [\"example\"]\n\n\n[supported_features]\nruns_offline = true\n\n[settings]\n[[settings.fields]]\nkey = \"example\"\nname = \"example\"\ndescription = \"example\"\nrequired = true\ndefault_value = \"example\"\ntype = \"example\"\nvalidations = \"example\"\nmarketingActivityCreateUrl = \"example\"\nmarketingActivityDeleteUrl = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "flowtrigger", + "typeDefinitions": { + "flowtrigger": { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "name": "flowtrigger", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.block_progress", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.customer_privacy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.sms_marketing", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.iframe.sources", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.network_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "schema", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].default_value", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].key", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityCreateUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityDeleteUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].required", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].validations", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "supported_features.runs_offline", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/flow-trigger.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uid", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface flowtrigger {\n 'name': string\n\n 'type': string\n\n 'handle': string\n\n 'uid'?: string\n\n 'description'?: string\n\n 'api_version'?: string\n\n 'extension_points'?: unknown\n\n 'capabilities.network_access'?: boolean\n\n 'capabilities.block_progress'?: boolean\n\n 'capabilities.api_access'?: boolean\n\n 'capabilities.collect_buyer_consent.sms_marketing'?: boolean\n\n 'capabilities.collect_buyer_consent.customer_privacy'?: boolean\n\n 'capabilities.iframe.sources'?: string[]\n\n 'supported_features.runs_offline'?: boolean\n\n 'settings.fields'?: object[]\n\n 'settings.fields[].key'?: string\n\n 'settings.fields[].name'?: string\n\n 'settings.fields[].description'?: string\n\n 'settings.fields[].required'?: boolean\n\n 'settings.fields[].default_value'?: unknown\n\n 'settings.fields[].type': string\n\n 'settings.fields[].validations'?: unknown\n\n 'settings.fields[].marketingActivityCreateUrl'?: string\n\n 'settings.fields[].marketingActivityDeleteUrl'?: string\n\n 'schema'?: string\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "function", + "description": "Configuration reference for function.", + "overviewPreviewDescription": "function TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"function\"\ntype = \"function\"\n\nuid = \"example\"\ndescription = \"example\"\napi_version = \"example\"\nextension_points = \"example\"\nconfiguration_ui = true\n[capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n[capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[capabilities.iframe]\nsources = [\"example\"]\n\n\n[supported_features]\nruns_offline = true\n\n[settings]\n[[settings.fields]]\nkey = \"example\"\nname = \"example\"\ndescription = \"example\"\nrequired = true\ndefault_value = \"example\"\ntype = \"example\"\nvalidations = \"example\"\nmarketingActivityCreateUrl = \"example\"\nmarketingActivityDeleteUrl = \"example\"\n\n\n[build]\ncommand = \"example\"\npath = \"example\"\nwatch = \"example\"\nwasm_opt = true\ntypegen_command = \"example\"\n\n[ui]\nenable_create = true\nhandle = \"example\"\n[ui.paths]\ncreate = \"example\"\ndetails = \"example\"\n\n\n[input]\n[input.variables]\nnamespace = \"example\"\nkey = \"example\"\n\n\n[[targeting]]\ntarget = \"example\"\ninput_query = \"example\"\nexport = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "functionConfig", + "typeDefinitions": { + "functionConfig": { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "name": "functionConfig", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "build.command", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "build.path", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "build.typegen_command", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "build.wasm_opt", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "build.watch", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.block_progress", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.customer_privacy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.sms_marketing", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.iframe.sources", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.network_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "configuration_ui", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "input.variables.key", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "input.variables.namespace", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].default_value", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].key", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityCreateUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityDeleteUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].required", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].validations", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "supported_features.runs_offline", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].export", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].input_query", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].target", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "ui.enable_create", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "ui.handle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "ui.paths.create", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "ui.paths.details", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/function.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uid", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface functionConfig {\n 'name': string\n\n 'type': string\n\n 'handle'?: string\n\n 'uid'?: string\n\n 'description'?: string\n\n 'api_version': string\n\n 'extension_points'?: unknown\n\n 'capabilities.network_access'?: boolean\n\n 'capabilities.block_progress'?: boolean\n\n 'capabilities.api_access'?: boolean\n\n 'capabilities.collect_buyer_consent.sms_marketing'?: boolean\n\n 'capabilities.collect_buyer_consent.customer_privacy'?: boolean\n\n 'capabilities.iframe.sources'?: string[]\n\n 'supported_features.runs_offline'?: boolean\n\n 'settings.fields'?: object[]\n\n 'settings.fields[].key'?: string\n\n 'settings.fields[].name'?: string\n\n 'settings.fields[].description'?: string\n\n 'settings.fields[].required'?: boolean\n\n 'settings.fields[].default_value'?: unknown\n\n 'settings.fields[].type': string\n\n 'settings.fields[].validations'?: unknown\n\n 'settings.fields[].marketingActivityCreateUrl'?: string\n\n 'settings.fields[].marketingActivityDeleteUrl'?: string\n\n 'build.command'?: string\n\n 'build.path'?: string\n\n 'build.watch'?: string\n\n 'build.wasm_opt'?: boolean\n\n 'build.typegen_command'?: string\n\n 'configuration_ui'?: boolean\n\n 'ui.enable_create'?: boolean\n\n 'ui.paths.create': string\n\n 'ui.paths.details': string\n\n 'ui.handle'?: string\n\n 'input.variables.namespace': string\n\n 'input.variables.key': string\n\n 'targeting'?: object[]\n\n 'targeting[].target': string\n\n 'targeting[].input_query'?: string\n\n 'targeting[].export'?: string\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Marketing Activity", + "description": "Configuration reference for Marketing Activity.", + "overviewPreviewDescription": "Marketing Activity TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Marketing Activity\"\ntype = \"marketing_activity\"\n\ntitle = \"example\"\ndescription = \"example\"\napi_path = \"example\"\ntactic = \"ad\"\nmarketing_channel = \"social\"\nreferring_domain = \"example\"\nis_automation = true\nuse_external_editor = true\nfields = [\"example\"]\n[preview_data]\n[[preview_data.types]]\nlabel = \"example\"\nvalue = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "marketingactivity", + "typeDefinitions": { + "marketingactivity": { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "name": "marketingactivity", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_path", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "fields", + "value": "object[]", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "is_automation", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "marketing_channel", + "value": "\"search\" | \"email\" | \"social\" | \"sms\" | \"display\" | \"marketplace\"", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "preview_data.types", + "value": "object[]", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "preview_data.types[].label", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "preview_data.types[].value", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "referring_domain", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "tactic", + "value": "\"message\" | \"link\" | \"ad\" | \"retargeting\" | \"post\" | \"transactional\" | \"newsletter\" | \"abandoned_cart\" | \"affililate\" | \"loyalty\" | \"storefront_app\"", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/marketing-activity.interface.ts", + "syntaxKind": "PropertySignature", + "name": "use_external_editor", + "value": "boolean", + "description": "", + "isOptional": true + } + ], + "value": "export interface marketingactivity {\n 'name'?: string\n\n 'title': string\n\n 'description': string\n\n 'api_path': string\n\n 'tactic': 'ad' | 'retargeting' | 'post' | 'message' | 'transactional' | 'newsletter' | 'abandoned_cart' | 'affililate' | 'loyalty' | 'link' | 'storefront_app'\n\n 'marketing_channel': 'social' | 'search' | 'email' | 'sms' | 'display' | 'marketplace'\n\n 'referring_domain'?: string\n\n 'is_automation'?: boolean\n\n 'use_external_editor'?: boolean\n\n 'preview_data.types': object[]\n\n 'preview_data.types[].label': string\n\n 'preview_data.types[].value': string\n\n 'fields': object[]\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Payments Extension", + "description": "Configuration reference for Payments Extension.", + "overviewPreviewDescription": "Payments Extension TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Payments Extension\"\ntype = \"payments_extension\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [], + "category": "extension-configuration", + "related": [] + }, + { + "name": "POS UI Extension", + "description": "Configuration reference for POS UI Extension.", + "overviewPreviewDescription": "POS UI Extension TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"POS UI Extension\"\ntype = \"pos_ui_extension\"\n\nuid = \"example\"\ndescription = \"example\"\napi_version = \"example\"\nextension_points = \"example\"\n[capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n[capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[capabilities.iframe]\nsources = [\"example\"]\n\n\n[supported_features]\nruns_offline = true\n\n[settings]\n[[settings.fields]]\nkey = \"example\"\nname = \"example\"\ndescription = \"example\"\nrequired = true\ndefault_value = \"example\"\ntype = \"example\"\nvalidations = \"example\"\nmarketingActivityCreateUrl = \"example\"\nmarketingActivityDeleteUrl = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "posuiextension", + "typeDefinitions": { + "posuiextension": { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "name": "posuiextension", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.block_progress", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.customer_privacy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.sms_marketing", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.iframe.sources", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.network_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].default_value", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].key", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityCreateUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityDeleteUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].required", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].validations", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "supported_features.runs_offline", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/pos-ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uid", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface posuiextension {\n 'name': string\n\n 'type'?: string\n\n 'handle'?: string\n\n 'uid'?: string\n\n 'description'?: string\n\n 'api_version'?: string\n\n 'extension_points'?: unknown\n\n 'capabilities.network_access'?: boolean\n\n 'capabilities.block_progress'?: boolean\n\n 'capabilities.api_access'?: boolean\n\n 'capabilities.collect_buyer_consent.sms_marketing'?: boolean\n\n 'capabilities.collect_buyer_consent.customer_privacy'?: boolean\n\n 'capabilities.iframe.sources'?: string[]\n\n 'supported_features.runs_offline'?: boolean\n\n 'settings.fields'?: object[]\n\n 'settings.fields[].key'?: string\n\n 'settings.fields[].name'?: string\n\n 'settings.fields[].description'?: string\n\n 'settings.fields[].required'?: boolean\n\n 'settings.fields[].default_value'?: unknown\n\n 'settings.fields[].type': string\n\n 'settings.fields[].validations'?: unknown\n\n 'settings.fields[].marketingActivityCreateUrl'?: string\n\n 'settings.fields[].marketingActivityDeleteUrl'?: string\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Product Subscription", + "description": "Configuration reference for Product Subscription.", + "overviewPreviewDescription": "Product Subscription TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Product Subscription\"\ntype = \"product_subscription\"\n\nuid = \"example\"\ndescription = \"example\"\napi_version = \"example\"\nextension_points = \"example\"\n[capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n[capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[capabilities.iframe]\nsources = [\"example\"]\n\n\n[supported_features]\nruns_offline = true\n\n[settings]\n[[settings.fields]]\nkey = \"example\"\nname = \"example\"\ndescription = \"example\"\nrequired = true\ndefault_value = \"example\"\ntype = \"example\"\nvalidations = \"example\"\nmarketingActivityCreateUrl = \"example\"\nmarketingActivityDeleteUrl = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "productsubscription", + "typeDefinitions": { + "productsubscription": { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "name": "productsubscription", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.block_progress", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.customer_privacy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.sms_marketing", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.iframe.sources", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.network_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].default_value", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].key", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityCreateUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityDeleteUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].required", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].validations", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "supported_features.runs_offline", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/product-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uid", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface productsubscription {\n 'name'?: string\n\n 'type'?: string\n\n 'handle'?: string\n\n 'uid'?: string\n\n 'description'?: string\n\n 'api_version'?: string\n\n 'extension_points'?: unknown\n\n 'capabilities.network_access'?: boolean\n\n 'capabilities.block_progress'?: boolean\n\n 'capabilities.api_access'?: boolean\n\n 'capabilities.collect_buyer_consent.sms_marketing'?: boolean\n\n 'capabilities.collect_buyer_consent.customer_privacy'?: boolean\n\n 'capabilities.iframe.sources'?: string[]\n\n 'supported_features.runs_offline'?: boolean\n\n 'settings.fields'?: object[]\n\n 'settings.fields[].key'?: string\n\n 'settings.fields[].name'?: string\n\n 'settings.fields[].description'?: string\n\n 'settings.fields[].required'?: boolean\n\n 'settings.fields[].default_value'?: unknown\n\n 'settings.fields[].type': string\n\n 'settings.fields[].validations'?: unknown\n\n 'settings.fields[].marketingActivityCreateUrl'?: string\n\n 'settings.fields[].marketingActivityDeleteUrl'?: string\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Subscription Link", + "description": "Configuration reference for Subscription Link.", + "overviewPreviewDescription": "Subscription Link TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Subscription Link\"\ntype = \"subscription_link_extension\"\n\npattern = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "subscriptionlinkextension", + "typeDefinitions": { + "subscriptionlinkextension": { + "filePath": "docs-shopify.dev/configuration/interfaces/subscription-link-extension.interface.ts", + "name": "subscriptionlinkextension", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/subscription-link-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/subscription-link-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "pattern", + "value": "string", + "description": "" + } + ], + "value": "export interface subscriptionlinkextension {\n 'pattern': string\n\n 'name'?: string\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Online Store - App Theme Extension", + "description": "Configuration reference for Online Store - App Theme Extension.", + "overviewPreviewDescription": "Online Store - App Theme Extension TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Online Store - App Theme Extension\"\ntype = \"theme\"\n\nuid = \"example\"\ndescription = \"example\"\napi_version = \"example\"\nextension_points = \"example\"\n[capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n[capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[capabilities.iframe]\nsources = [\"example\"]\n\n\n[supported_features]\nruns_offline = true\n\n[settings]\n[[settings.fields]]\nkey = \"example\"\nname = \"example\"\ndescription = \"example\"\nrequired = true\ndefault_value = \"example\"\ntype = \"example\"\nvalidations = \"example\"\nmarketingActivityCreateUrl = \"example\"\nmarketingActivityDeleteUrl = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "theme", + "typeDefinitions": { + "theme": { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "name": "theme", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.block_progress", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.customer_privacy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.sms_marketing", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.iframe.sources", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.network_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].default_value", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].key", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityCreateUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityDeleteUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].required", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].validations", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "supported_features.runs_offline", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/theme.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uid", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface theme {\n 'name'?: string\n\n 'type'?: string\n\n 'handle'?: string\n\n 'uid'?: string\n\n 'description'?: string\n\n 'api_version'?: string\n\n 'extension_points'?: unknown\n\n 'capabilities.network_access'?: boolean\n\n 'capabilities.block_progress'?: boolean\n\n 'capabilities.api_access'?: boolean\n\n 'capabilities.collect_buyer_consent.sms_marketing'?: boolean\n\n 'capabilities.collect_buyer_consent.customer_privacy'?: boolean\n\n 'capabilities.iframe.sources'?: string[]\n\n 'supported_features.runs_offline'?: boolean\n\n 'settings.fields'?: object[]\n\n 'settings.fields[].key'?: string\n\n 'settings.fields[].name'?: string\n\n 'settings.fields[].description'?: string\n\n 'settings.fields[].required'?: boolean\n\n 'settings.fields[].default_value'?: unknown\n\n 'settings.fields[].type': string\n\n 'settings.fields[].validations'?: unknown\n\n 'settings.fields[].marketingActivityCreateUrl'?: string\n\n 'settings.fields[].marketingActivityDeleteUrl'?: string\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "UI Extension", + "description": "Configuration reference for UI Extension.", + "overviewPreviewDescription": "UI Extension TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"UI Extension\"\ntype = \"ui_extension\"\n\nuid = \"example\"\ndescription = \"example\"\napi_version = \"example\"\n[capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n[capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[capabilities.iframe]\nsources = [\"example\"]\n\n\n[supported_features]\nruns_offline = true\n\n[settings]\n[[settings.fields]]\nkey = \"example\"\nname = \"example\"\ndescription = \"example\"\nrequired = true\ndefault_value = \"example\"\ntype = \"example\"\nvalidations = \"example\"\nmarketingActivityCreateUrl = \"example\"\nmarketingActivityDeleteUrl = \"example\"\n\n\n[[extension_points]]\ntarget = \"example\"\nmodule = \"example\"\ntools = \"example\"\ninstructions = \"example\"\ndefault_placement = \"example\"\n[extension_points.should_render]\nmodule = \"example\"\n\n[extension_points.urls]\nedit = \"example\"\n\n[extension_points.capabilities]\nallow_direct_linking = true\n\n[extension_points.preloads]\nchat = \"example\"\n\n[[extension_points.metafields]]\nnamespace = \"example\"\nkey = \"example\"\n\n\n[[targeting]]\ntarget = \"example\"\nmodule = \"example\"\ntools = \"example\"\ninstructions = \"example\"\ndefault_placement = \"example\"\n[targeting.should_render]\nmodule = \"example\"\n\n[targeting.urls]\nedit = \"example\"\n\n[targeting.capabilities]\nallow_direct_linking = true\n\n[targeting.preloads]\nchat = \"example\"\n\n[[targeting.metafields]]\nnamespace = \"example\"\nkey = \"example\"\n\n\n[[metafields]]\nnamespace = \"example\"\nkey = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "uiextension", + "typeDefinitions": { + "uiextension": { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "name": "uiextension", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.block_progress", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.customer_privacy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.sms_marketing", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.iframe.sources", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.network_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points[].capabilities.allow_direct_linking", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points[].default_placement", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points[].instructions", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points[].metafields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points[].metafields[].key", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points[].metafields[].namespace", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points[].module", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points[].preloads.chat", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points[].should_render.module", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points[].target", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points[].tools", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points[].urls.edit", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "metafields[].key", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "metafields[].namespace", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].default_value", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].key", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityCreateUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].marketingActivityDeleteUrl", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].required", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings.fields[].validations", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "supported_features.runs_offline", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].capabilities.allow_direct_linking", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].default_placement", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].instructions", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].metafields", + "value": "object[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].metafields[].key", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].metafields[].namespace", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].module", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].preloads.chat", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].should_render.module", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].target", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].tools", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "targeting[].urls.edit", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/ui-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uid", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface uiextension {\n 'name': string\n\n 'type': string\n\n 'handle'?: string\n\n 'uid'?: string\n\n 'description'?: string\n\n 'api_version'?: string\n\n 'extension_points'?: object[]\n\n 'extension_points[].target': string\n\n 'extension_points[].module': string\n\n 'extension_points[].should_render.module': string\n\n 'extension_points[].tools'?: string\n\n 'extension_points[].instructions'?: string\n\n 'extension_points[].metafields'?: object[]\n\n 'extension_points[].metafields[].namespace': string\n\n 'extension_points[].metafields[].key': string\n\n 'extension_points[].default_placement'?: string\n\n 'extension_points[].urls.edit'?: string\n\n 'extension_points[].capabilities.allow_direct_linking'?: boolean\n\n 'extension_points[].preloads.chat'?: string\n\n 'capabilities.network_access'?: boolean\n\n 'capabilities.block_progress'?: boolean\n\n 'capabilities.api_access'?: boolean\n\n 'capabilities.collect_buyer_consent.sms_marketing'?: boolean\n\n 'capabilities.collect_buyer_consent.customer_privacy'?: boolean\n\n 'capabilities.iframe.sources'?: string[]\n\n 'supported_features.runs_offline'?: boolean\n\n 'settings.fields'?: object[]\n\n 'settings.fields[].key'?: string\n\n 'settings.fields[].name'?: string\n\n 'settings.fields[].description'?: string\n\n 'settings.fields[].required'?: boolean\n\n 'settings.fields[].default_value'?: unknown\n\n 'settings.fields[].type': string\n\n 'settings.fields[].validations'?: unknown\n\n 'settings.fields[].marketingActivityCreateUrl'?: string\n\n 'settings.fields[].marketingActivityDeleteUrl'?: string\n\n 'targeting'?: object[]\n\n 'targeting[].target': string\n\n 'targeting[].module': string\n\n 'targeting[].should_render.module': string\n\n 'targeting[].tools'?: string\n\n 'targeting[].instructions'?: string\n\n 'targeting[].metafields'?: object[]\n\n 'targeting[].metafields[].namespace': string\n\n 'targeting[].metafields[].key': string\n\n 'targeting[].default_placement'?: string\n\n 'targeting[].urls.edit'?: string\n\n 'targeting[].capabilities.allow_direct_linking'?: boolean\n\n 'targeting[].preloads.chat'?: string\n\n 'metafields'?: object[]\n\n 'metafields[].namespace': string\n\n 'metafields[].key': string\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Web Pixel Extension", + "description": "Configuration reference for Web Pixel Extension.", + "overviewPreviewDescription": "Web Pixel Extension TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Web Pixel Extension\"\ntype = \"web_pixel_extension\"\n\nuid = \"example\"\ndescription = \"example\"\napi_version = \"example\"\nextension_points = \"example\"\nsettings = \"example\"\nruntime_context = \"example\"\nversion = \"example\"\nconfiguration = \"example\"\n[capabilities]\nnetwork_access = true\nblock_progress = true\napi_access = true\n[capabilities.collect_buyer_consent]\nsms_marketing = true\ncustomer_privacy = true\n\n[capabilities.iframe]\nsources = [\"example\"]\n\n\n[supported_features]\nruns_offline = true\n\n[customer_privacy]\nanalytics = true\npreferences = true\nmarketing = true\nsale_of_data = \"enabled\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "webpixelextension", + "typeDefinitions": { + "webpixelextension": { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "name": "webpixelextension", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.api_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.block_progress", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.customer_privacy", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.collect_buyer_consent.sms_marketing", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.iframe.sources", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities.network_access", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "configuration", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "customer_privacy.analytics", + "value": "boolean", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "customer_privacy.marketing", + "value": "boolean", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "customer_privacy.preferences", + "value": "boolean", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "customer_privacy.sale_of_data", + "value": "\"disabled\" | \"enabled\" | \"ldu\"", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "extension_points", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "runtime_context", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "settings", + "value": "unknown", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "supported_features.runs_offline", + "value": "boolean", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uid", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/web-pixel-extension.interface.ts", + "syntaxKind": "PropertySignature", + "name": "version", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface webpixelextension {\n 'name'?: string\n\n 'type'?: string\n\n 'handle'?: string\n\n 'uid'?: string\n\n 'description'?: string\n\n 'api_version'?: string\n\n 'extension_points'?: unknown\n\n 'capabilities.network_access'?: boolean\n\n 'capabilities.block_progress'?: boolean\n\n 'capabilities.api_access'?: boolean\n\n 'capabilities.collect_buyer_consent.sms_marketing'?: boolean\n\n 'capabilities.collect_buyer_consent.customer_privacy'?: boolean\n\n 'capabilities.iframe.sources'?: string[]\n\n 'supported_features.runs_offline'?: boolean\n\n 'settings'?: unknown\n\n 'runtime_context': string\n\n 'version'?: string\n\n 'configuration'?: unknown\n\n 'customer_privacy.analytics': boolean\n\n 'customer_privacy.preferences': boolean\n\n 'customer_privacy.marketing': boolean\n\n 'customer_privacy.sale_of_data': 'enabled' | 'disabled' | 'ldu'\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] + }, + { + "name": "Webhooks Subscriptions", + "description": "Configuration reference for Webhooks Subscriptions.", + "overviewPreviewDescription": "Webhooks Subscriptions TOML configuration.", + "type": "resource", + "isVisualComponent": false, + "defaultExample": { + "codeblock": { + "tabs": [ + { + "title": "shopify.extension.toml", + "code": "name = \"Webhooks Subscriptions\"\ntype = \"webhook_subscription\"\n\ntopic = \"example\"\nactions = [\"example\"]\napi_version = \"example\"\nuri = \"example\"\ninclude_fields = [\"example\"]\nfilter = \"example\"\npayload_query = \"example\"\n", + "language": "toml" + } + ], + "title": "Example configuration" + } + }, + "definitions": [ + { + "title": "Properties", + "description": "The following properties are available:", + "type": "webhooksubscription", + "typeDefinitions": { + "webhooksubscription": { + "filePath": "docs-shopify.dev/configuration/interfaces/webhook-subscription.interface.ts", + "name": "webhooksubscription", + "description": "", + "members": [ + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhook-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "actions", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhook-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "api_version", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhook-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "filter", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhook-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "include_fields", + "value": "string[]", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhook-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhook-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "payload_query", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhook-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "topic", + "value": "string", + "description": "" + }, + { + "filePath": "docs-shopify.dev/configuration/interfaces/webhook-subscription.interface.ts", + "syntaxKind": "PropertySignature", + "name": "uri", + "value": "string", + "description": "" + } + ], + "value": "export interface webhooksubscription {\n 'topic': string\n\n 'actions'?: string[]\n\n 'api_version': string\n\n 'uri': string\n\n 'include_fields'?: string[]\n\n 'filter'?: string\n\n 'payload_query'?: string\n\n 'name'?: string\n}" + } + } + } + ], + "category": "extension-configuration", + "related": [] } ] \ No newline at end of file