# Create Experience

The following experience types are supported by the Intelligems Experiments API:

* `content/advanced` — Advanced content test (custom CSS/JS injection)
* `content/onsiteEdits` — Onsite edits (visual editor changes)
* `content/url` — URL redirects
* `content/theme` — Theme redirects
* `content/template` — Template redirects
* `personalization` — Personalization rules
* `personalization/offer` — Offer test (structured discount campaigns configured via the `offer` field on each variation)

The following test types are not currently supported via this API:

* Checkout Blocks
* Pricing
* Shipping
* Campaigns

All fields (experience metadata, variations, audience, page targeting, and key metrics) are nested inside a single `experience` object in the request body.

## POST /v25-10-beta/experiences

> Creates a new experience.\
> \
> The experience will be created in a draft state and must be activated separately before it will be served to visitors.\
> \
> \### Required Fields\
> \
> \- \`name\` - A unique name for the experience\
> \- \`type\` - The type of test (content, redirect, etc.)\
> \- \`variations\` - At least one variation must be provided

```json
{"openapi":"3.1.0","info":{"title":"Intelligems External API v25-10-beta","version":"v25-10-beta"},"tags":[{"name":"Create Experience","description":"The following experience types are supported by the Intelligems Experiments API:\n\n- `content/advanced` — Advanced content test (custom CSS/JS injection)\n- `content/onsiteEdits` — Onsite edits (visual editor changes)\n- `content/url` — URL redirects\n- `content/theme` — Theme redirects\n- `content/template` — Template redirects\n- `personalization` — Personalization rules\n- `personalization/offer` — Offer test (structured discount campaigns configured via the `offer` field on each variation)\n\nThe following test types are not currently supported via this API:\n\n- Checkout Blocks\n- Pricing\n- Shipping\n- Campaigns\n\nAll fields (experience metadata, variations, audience, page targeting, and key metrics) are nested inside a single `experience` object in the request body."}],"servers":[{"url":"https://api.intelligems.io","description":"Production"}],"security":[{"intelligems_access_token":[]}],"components":{"securitySchemes":{"intelligems_access_token":{"type":"apiKey","in":"header","name":"intelligems-access-token","description":"Intelligems external API access token."}},"schemas":{"__schema0":{"type":"object","properties":{"expression":{"type":"array","items":{"type":"object","properties":{"query":{"type":"object","properties":{"key":{"type":"string","enum":["shopifyRecommendations","productId","collection","tag"]},"type":{"type":"string","enum":["shopifyRecommendations","productId","collection","tag"]},"filter":{"type":"string","enum":["includes","doesNotInclude"]},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"object","properties":{"order":{"type":"number"},"productId":{"type":"string"},"productTitle":{"type":"string"},"productImage":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["name","values"],"additionalProperties":false}},"variants":{"type":"array","items":{"type":"object","properties":{"variantId":{"type":"string"},"variantTitle":{"type":"string"},"variantImage":{"anyOf":[{"type":"string"},{"type":"null"}]},"price":{"type":"number"},"compareAtPrice":{"anyOf":[{"type":"number"},{"type":"null"}]},"currencyCode":{"type":"string"},"availableForSale":{"type":"boolean"},"inclusionType":{"type":"string","enum":["include","exclude"]},"variantOptions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"additionalProperties":false}}},"required":["variantId","variantTitle","price","inclusionType"],"additionalProperties":false}}},"required":["order","productId","productTitle","variants"],"additionalProperties":false}}]}},"required":["key","type"],"additionalProperties":false},"operator":{"type":"string","enum":["and","or","start_paren","end_paren"]}},"additionalProperties":false}},"discountType":{"default":"none","type":"string","enum":["none","percentage","fixed"]},"discountValue":{"anyOf":[{"type":"number"},{"type":"null"}]},"compareAtPriceDisplay":{"default":"none","type":"string","enum":["none","compareAtPrice","regularPrice"]},"onAccept":{"anyOf":[{"$ref":"#/components/schemas/__schema0"},{"type":"null"}]},"onDecline":{"anyOf":[{"$ref":"#/components/schemas/__schema0"},{"type":"null"}]}},"required":["expression","discountType","compareAtPriceDisplay"],"additionalProperties":false}}},"paths":{"/v25-10-beta/experiences":{"post":{"tags":["Create Experience"],"description":"Creates a new experience.\n\nThe experience will be created in a draft state and must be activated separately before it will be served to visitors.\n\n### Required Fields\n\n- `name` - A unique name for the experience\n- `type` - The type of test (content, redirect, etc.)\n- `variations` - At least one variation must be provided","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"experience":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Display name shown in dashboards and reports."},"description":{"description":"Internal note explaining what this experience tests. Helpful for team context.","anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"description":"Currency for price display and analytics. Omit to default to USD.","anyOf":[{"type":"object","properties":{"code":{"default":"USD","description":"ISO 4217 currency code used for analytics and price calculations.","type":"string"},"country":{"description":"ISO country code for locale-specific formatting.","type":"string"},"options":{"description":"Additional locale-specific formatting options."},"symbol":{"default":"$","description":"Display symbol prepended to amounts (e.g., '$', '€').","type":"string"},"suffix":{"description":"Text appended after amounts for postfix currencies (e.g., 'kr' in '100 kr').","type":"string"}}},{"type":"null"}]},"previewPath":{"description":"Store URL path for generating preview links (e.g., '/products/example').","anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string","enum":["content/advanced","content/onsiteEdits","content/url","content/theme","content/template","personalization","personalization/offer"],"description":"Immutable after creation. Must match the existing value from GET response."},"experienceAnalysis":{"type":"object","properties":{"analyticsViewType":{"default":"none","description":"Scope of orders included in analytics results. Determines whether only tested products or all store orders are counted.","type":"string","enum":["test_orders_only","sitewide_orders","none"]}},"description":"Controls which orders are included in analytics results."},"variations":{"description":"Full replacement — include ALL variations to keep. Omitted variations are deleted. One must be control, percentages must sum to 100. Match variation mechanisms to experience type: onsiteEdits for DOM changes, onsiteInjection for CSS/JS, redirects for URL/theme/template tests.","minItems":1,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Display name (e.g., 'Control', 'Variant A'). Must be unique across variations."},"percentage":{"type":"number","minimum":0,"maximum":100,"description":"Traffic allocation weight. All percentages across variations must sum to 100."},"isControl":{"default":false,"description":"The baseline variation all others are measured against. Exactly one per experience.","type":"boolean"},"order":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Display order in analytics. Must be unique across variations. 0-indexed."},"cartTargeting":{"description":"Cart-based targeting rules that determine when this variation is shown based on cart contents.","default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expression":{"type":"array","items":{"type":"object","properties":{"query":{"type":"object","properties":{"key":{"type":"string","enum":["anything","productId","collection","tag","cartSubtotal","cartItemCount"]},"type":{"type":"string","enum":["anything","productId","collection","tag","cartSubtotal","cartItemCount"]},"filter":{"type":"string","enum":["includes","doesNotInclude","greaterThan","lessThan","equalTo","greaterThanOrEqual","lessThanOrEqual","between"]},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"object","properties":{"variantId":{"type":"string"},"inclusionType":{"type":"string","enum":["include","exclude"]}},"required":["variantId","inclusionType"]}}}]}},"required":["key","type","filter"]},"operator":{"type":"string","enum":["and","or","start_paren","end_paren"]}}}}},"required":["id","expression"]}},"onsiteEdits":{"default":[],"description":"Full replacement — include ALL edits to keep. Omitted edits are deleted. ONLY for DOM content changes (text replacement, HTML insertion, image swaps, element removal). Do NOT create onsiteEdits for visual styling changes like colors, backgrounds, fonts, or layout — use onsiteInjection.customCss instead. Leave as empty array when only CSS/JS changes are needed.","type":"array","items":{"type":"object","properties":{"onsiteEditType":{"description":"Content modification strategy (rich HTML, plain text, image swap, or element removal).","anyOf":[{"type":"string","enum":["html","text","image","hide"]},{"type":"null"}]},"find":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pattern to find on the page. Set isRegex=true for regex. Null when using querySelectors with 'hide' or 'image' type."},"title":{"description":"Dashboard label for organizing multiple edits.","anyOf":[{"type":"string"},{"type":"null"}]},"isRegex":{"default":false,"description":"Set to true to interpret 'find' as a regex pattern.","type":"boolean"},"replace":{"default":"","description":"Replacement content: HTML markup for 'html' type, plain text for 'text', image URL for 'image'.","type":"string"},"querySelectors":{"default":[""],"description":"CSS selectors scoping where the edit applies (e.g., '.product-title').","type":"array","items":{"type":"string"}},"skip":{"default":false,"description":"Set to true to temporarily disable without deleting.","type":"boolean"},"remove":{"default":false,"description":"Set to true to remove the matched element entirely instead of replacing.","type":"boolean"},"groupId":{"description":"Edits sharing a groupId are managed together as a unit.","type":"string"},"insertType":{"anyOf":[{"type":"string","enum":["beforebegin","afterbegin","beforeend","afterend"]},{"type":"null"}],"description":"DOM insertion position relative to target element. Null for content replacement (default)."},"imageSearchUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"URL pathname to match for image replacement. Mutually exclusive with querySelectors for image edits."},"source":{"anyOf":[{"type":"string","enum":["ai"]},{"type":"null"}]}},"required":["find","insertType"]}},"onsiteInjection":{"description":"Full replacement. Set to null to remove. Use for all visual styling changes (background-color, font-size, colors, borders, layout, etc.) via customCss, and custom behavior via customJs. CSS-only changes should use ONLY this field with an empty onsiteEdits array — do not create a corresponding onsiteEdit.","anyOf":[{"type":"object","properties":{"customCss":{"description":"CSS injected globally on the page when this variation is active.","anyOf":[{"type":"string"},{"type":"null"}]},"customJs":{"description":"JavaScript executed on the page. Execution timing controlled by jsInjectionMode.","anyOf":[{"type":"string"},{"type":"null"}]},"jsInjectionMode":{"type":"object","properties":{"type":{"default":"immediately","description":"Execution timing for injected JS. When 'timeout', the timeout field specifies the delay.","type":"string","enum":["immediately","onWindowLoad","timeout"]},"timeout":{"description":"Delay in milliseconds before JS execution. Only relevant when type is 'timeout'.","anyOf":[{"type":"number"},{"type":"string"}]}},"description":"Controls when customJs runs: immediately on load, after window load, or after a configurable delay."},"source":{"anyOf":[{"type":"string","enum":["ai"]},{"type":"null"}]}},"required":["customCss","customJs","jsInjectionMode"]},{"type":"null"}]},"offer":{"anyOf":[{"type":"object","properties":{"enabled":{"default":false,"description":"Whether the offer is actively applying discounts to customers on the storefront.","type":"boolean"},"isTest":{"default":false,"description":"When true, the offer exists in draft mode and is not applied to customers.","type":"boolean"},"isArchived":{"default":false,"description":"Whether the offer has been archived and is no longer active.","type":"boolean"},"name":{"type":"string","description":"Internal label for identifying the offer in dashboards."},"unitType":{"default":"dollar","description":"Threshold basis for tiered discounts: per-item quantity or monetary amount spent.","type":"string","enum":["unit","dollar"]},"discountType":{"default":"dollar","description":"How the discount value is calculated (e.g., percentage off, fixed amount off).","type":"string","enum":["percentage","dollar"]},"tiers":{"default":[],"description":"Volume discount tiers ordered by threshold ascending (e.g., buy 2 = 10% off, buy 3 = 15% off).","type":"array","items":{"type":"object","properties":{"minimumUnits":{"default":1,"type":"number","minimum":0},"maximumUnits":{"default":1,"type":"number","minimum":0},"unitDiscount":{"default":1,"type":"number","minimum":0},"discountTitle":{"default":null,"anyOf":[{"type":"string"},{"type":"null"}]},"giftWithPurchaseTitle":{"default":null,"anyOf":[{"type":"string"},{"type":"null"}]},"isFreeShipping":{"default":false,"type":"boolean"},"isGiftWithPurchase":{"default":false,"type":"boolean"},"giftWithPurchaseProductId":{"anyOf":[{"type":"string"},{"type":"null"}]},"giftWithPurchaseVariantId":{"anyOf":[{"type":"string"},{"type":"null"}]},"autoAddGiftWithPurchase":{"default":false,"type":"boolean"},"giftWithPurchaseHandle":{"anyOf":[{"type":"string"},{"type":"null"}]}}}},"maximumDollarDiscount":{"description":"Hard cap on the total dollar discount. Null means no cap is applied.","anyOf":[{"type":"number"},{"type":"null"}]},"discountApplicationType":{"type":"string","enum":["tieredDiscount","cartDiscount","freeGift","freeShipping",""],"description":"Core discount mechanic (tiered volume, flat cart-level, gift-with-purchase, or free shipping)."},"discountApplicationMethod":{"type":"string","enum":["perItem","perOrder"],"description":"Whether the discount applies per individual item or to the entire order."},"combinesWithIntelligems":{"type":"boolean","description":"Whether this offer stacks with other active Intelligems discounts."},"combinesWithShopify":{"type":"boolean","description":"Whether this offer stacks with native Shopify discount codes."},"shouldRejectCodes":{"type":"boolean","description":"When true, manual discount codes entered at checkout are rejected while this offer is active."},"shippingDiscount":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"discountType":{"type":"string","enum":["percentage","dollar"]},"unitDiscount":{"type":"number"},"rateFilter":{"anyOf":[{"anyOf":[{"type":"object","properties":{"type":{"type":"string","const":"amount"},"amount":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"type":{"type":"string","const":"name"},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["is","contains","isNot","doesNotContain","startsWith","doesNotStartWith"]},"name":{"type":"string"}},"required":["id","operator","name"]}}},"required":["type","rules"]}]},{"type":"null"}]},"countryFilter":{"anyOf":[{"type":"object","properties":{"allow":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}}}},{"type":"null"}]},"discountLabel":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","discountType","unitDiscount","rateFilter","countryFilter","discountLabel"]},{"type":"null"}],"description":"Shipping discount details. Only present when discountApplicationType is freeShipping."},"requireSameItem":{"default":false,"description":"For tiered discounts: when true, only multiples of the same product count toward thresholds.","type":"boolean"},"subscriptionApplicationType":{"default":"oneTime","description":"Controls which purchase types this offer applies to: 'oneTime' (one-time purchases only), 'firstSub' (first subscription orders only), or 'oneTimeAndFirstSub' (both one-time and first subscription orders).","type":"string","enum":["oneTime","firstSub","oneTimeAndFirstSub"]}},"required":["name","discountApplicationType","discountApplicationMethod","combinesWithIntelligems","combinesWithShopify","shouldRejectCodes","shippingDiscount"]},{"type":"null"}]},"redirects":{"default":[],"type":"array","items":{"type":"object","properties":{"group":{"type":"number","description":"Redirects sharing the same originUrl should use the same group number."},"originUrl":{"type":"string","description":"URL pattern to match. Matching behavior controlled by 'filter' field."},"destinationUrl":{"description":"Target URL. Required when redirectType is 'fullReplacement'.","anyOf":[{"type":"string"},{"type":"null"}]},"queryParams":{"default":[],"description":"Appended to the destination URL.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Query parameter name appended to the destination URL."},"value":{"type":"string","description":"Query parameter value."}},"required":["key","value"]}},"skip":{"type":"boolean","description":"Set to true to temporarily disable without deleting."},"isThemeTest":{"type":"boolean","description":"Set to true for Shopify theme testing. Use with content/theme experience type."},"isTemplateTest":{"type":"boolean","description":"Set to true for Shopify template testing. Use with content/template experience type."},"templateType":{"description":"Required when isTemplateTest is true.","anyOf":[{"type":"string","enum":["404","","article","blog","cart","collection","index","list-collections","page","password","product","search"]},{"type":"null"}]},"templateSuffixes":{"default":[],"description":"Template suffix variations to test. Required when isTemplateTest is true.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"redirectOnce":{"default":false,"description":"Set to true to fire only once per visitor session.","type":"boolean"},"filter":{"default":"matchesExactly","description":"How originUrl is matched against the current page URL.","type":"string","enum":["matchesExactly","contains","endsWith","matchesRegex","none"]},"find":{"description":"Pattern to find in the URL. Required when redirectType is 'partialReplacement'.","anyOf":[{"type":"string"},{"type":"null"}]},"redirectType":{"default":"fullReplacement","description":"Full replacement navigates to destinationUrl; partial replacement swaps only the 'find' match within the current URL.","type":"string","enum":["fullReplacement","partialReplacement"]}},"required":["group","originUrl","skip","isThemeTest","isTemplateTest"]}}},"required":["name","percentage","order"]}},"audience":{"description":"Omit entirely to remove audience targeting from the experience.","type":"object","properties":{"enabled":{"type":"boolean","description":"Set to true to enforce filter rules. When false, all visitors are included."},"audienceType":{"description":"Complexity level: prebuilt common rules, simple custom rules, or advanced expression trees.","type":"string","enum":["common","custom","advanced"]},"elseAction":{"anyOf":[{"type":"string","enum":["experienceInclude","experienceExclude","experienceUnassigned","assignVariation","randomVariation","leaveUnassigned"]},{"type":"null"}],"description":"Fallback for visitors matching no filter: 'randomVariation' assigns randomly (most common), 'assignVariation' forces a specific variation (set elseVariationIndex), 'experienceExclude' removes from experience, 'leaveUnassigned' skips assignment."},"elseExcludeFromAnalytics":{"default":false,"description":"Set to true to exclude non-matching visitors from analytics.","type":"boolean"},"filters":{"default":[],"description":"Evaluated in priority order (0-indexed). Each filter defines a targeting condition and resulting action.","type":"array","items":{"type":"object","properties":{"priority":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Evaluation order. 0-indexed. Filters with lower values are evaluated first."},"action":{"anyOf":[{"type":"string","enum":["experienceInclude","experienceExclude","experienceUnassigned","assignVariation","randomVariation","leaveUnassigned"]},{"type":"null"}],"description":"What happens when a visitor matches this filter: 'assignVariation' forces a specific variation (set variationId), 'experienceExclude' removes from the experience, 'randomVariation' assigns randomly."},"filterType":{"type":"string","enum":["utm","url","urlPath","device","visitor","jsExpression","trafficSource","country","referrer","cookie","klaviyo","landingPage"],"description":"Category of targeting rule (e.g., UTM parameters, device type, visitor type)."},"expression":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"query":{"type":"object","properties":{"key":{"type":"string","description":"Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')."},"value":{"type":"string","description":"Expected value to compare against the visitor's actual value for this key."},"filter":{"description":"Comparison operator (e.g., equals, contains, startsWith).","anyOf":[{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},{"type":"null"}]},"type":{"default":"utm","description":"Category of the parameter being matched. Determines which keys are valid.","type":"string","enum":["utm","url","urlPath","device","visitor","jsExpression","trafficSource","country","referrer","cookie","klaviyo","landingPage"]}},"required":["key","value"]},"operator":{"type":"string","enum":["and","or","start_paren","end_paren"]}}}},{"type":"null"}],"description":"Boolean expression tree. Each node has either a 'query' (leaf condition) or 'operator' (logical combinator), not both."},"expressionType":{"description":"Whether this uses prebuilt common rules or custom expression logic.","anyOf":[{"type":"string","enum":["common","custom"]},{"type":"null"}]},"variationId":{"description":"Variation to assign when action is 'assignVariation'. References a variation in the parent experience.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"excludeFromAnalytics":{"default":false,"description":"When true, visitors matching this filter are excluded from analytics even if included in the experience.","type":"boolean"}},"required":["priority","action","filterType"]}},"evaluationFrequency":{"description":"Seconds between re-evaluations for a visitor. Omit for default.","anyOf":[{"type":"number"},{"type":"null"}]},"elseVariationIndex":{"description":"0-based index into the variations array. Use instead of elseVariationId since IDs don't exist yet during creation.","type":"string"}},"required":["enabled","elseAction"]},"experiencePageTargeting":{"default":[],"description":"Full replacement — include ALL page targeting rules to keep. Omitted rules are deleted.","type":"array","items":{"type":"object","properties":{"expression":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"query":{"type":"object","properties":{"key":{"type":"string","description":"Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')."},"value":{"type":"string","description":"Expected value to compare against the visitor's actual value for this key."},"filter":{"description":"Comparison operator (e.g., equals, contains, startsWith).","anyOf":[{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},{"type":"null"}]},"type":{"default":"utm","description":"Category of the parameter being matched. Determines which keys are valid.","type":"string","enum":["utm","url","urlPath","device","visitor","jsExpression","trafficSource","country","referrer","cookie","klaviyo","landingPage"]}},"required":["key","value"]},"operator":{"type":"string","enum":["and","or","start_paren","end_paren"]}}}},{"type":"null"}]}}}},"experienceKeyMetrics":{"default":[],"description":"Full replacement — include ALL metrics to keep. Omitted metrics are deleted. Exactly one must be primary.","type":"array","items":{"type":"object","properties":{"order":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Display order in analytics. Must be unique across metrics. 0-indexed."},"isPrimary":{"default":false,"description":"Exactly one metric per experience must be primary.","type":"boolean"},"standardEventId":{"description":"Standard e-commerce event to track. Mutually exclusive with experienceCustomMetricId -- set exactly one.","anyOf":[{"type":"string","enum":["conversionRate","addToCartRate","abandonedCartRate","abandonedCheckoutRate","checkoutBeginRate","checkoutEnterContactInfoRate","checkoutAddressSubmittedRate","viewProductPageRate","viewCollectionPageRate","netRevenuePerVisitor","netProductRevenuePerOrder","netRevenuePerOrder","avgUnitsPerOrder","avgProductRevenuePerUnit","profitPerVisitor","profitPerOrder","pctOrdersFreeShipping","netShippingRevenuePerOrder","subscriptionOrdersPerVisitor","subscriptionRevenuePerVisitor","subscriptionProfitPerVisitor","subscriptionProductRevenuePerOrder","avgDiscountPerDiscountedOrder","avgDiscountPerAllOrders","pctSubscriptionOrders","subscriptionRevenuePerOrder"]},{"type":"null"}]},"experienceCustomMetricId":{"description":"References a custom metric. Mutually exclusive with standardEventId -- set exactly one.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["order"]}}},"required":["name","type","experienceAnalysis","variations"],"description":"The complete experience object containing settings, variations, audience, page targeting, and key metrics. For PUT: include id fields from the GET response on all nested entities."}},"required":["experience"]}}}},"responses":{"200":{"description":"OK","headers":{"access-control-allow-origin":{"schema":{"type":"string"},"description":"CORS allow-origin header."},"access-control-allow-credentials":{"schema":{"type":"string"},"description":"CORS allow-credentials header."},"content-type":{"schema":{"type":"string"},"description":"Response content type."},"Timing-Allow-Origin":{"schema":{"type":"string"},"description":"Allowed origin for Timing headers."}},"content":{"application/json":{"schema":{"type":"object","properties":{"experience":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"name":{"type":"string","description":"Display name shown in dashboards and reports."},"isPreview":{"default":true,"description":"True while in draft mode. Must be set to false before the experience can be started.","type":"boolean"},"description":{"description":"Internal note explaining what this experience tests.","anyOf":[{"type":"string"},{"type":"null"}]},"devicePreview":{"description":"Device and path configuration for the preview iframe.","anyOf":[{"type":"object","properties":{"device":{"default":"desktop","description":"Viewport to simulate when rendering the preview.","type":"string","enum":["any","mobile","desktop"]},"path":{"default":"/","description":"Storefront URL path to load in the preview (e.g., '/products/example').","type":"string"}},"required":["device","path"],"additionalProperties":false,"description":"Device and path configuration for previewing the experience."},{"type":"null"}]},"organizationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only. The Shopify store that owns this experience."},"type":{"type":"string","enum":["content/advanced","content/onsiteEdits","content/url","content/theme","content/template","personalization","personalization/offer","pricing","shipping","sitewide","checkoutBlock","postPurchase"],"description":"Determines which variation fields are relevant: content/onsiteEdits for DOM edits, content/advanced for CSS/JS injection, content/url for redirect split tests, content/theme for theme tests, content/template for template tests."},"category":{"type":"string","enum":["experiment","personalization"],"description":"Distinguishes A/B experiments (statistical testing) from personalization rules (deterministic targeting)."},"status":{"type":"string","enum":["pending","started","ended","paused"],"description":"Server-managed lifecycle state. Transitions via start/pause/end actions: pending -> started -> paused/ended."},"testTypes":{"type":"object","properties":{"hasTestPricing":{"type":"boolean","description":"Server-generated. Read-only. True when price testing is active."},"hasTestShipping":{"type":"boolean","description":"Server-generated. Read-only. True when shipping rate testing is active."},"hasTestCampaign":{"type":"boolean","description":"Server-generated. Read-only. True when campaign/offer testing is active."},"hasTestContent":{"type":"boolean","description":"Server-generated. Read-only. True when any content variation type is enabled."},"hasTestContentUrl":{"type":"boolean","description":"Server-generated. Read-only. True when URL redirect variations are in use."},"hasTestContentAdvanced":{"type":"boolean","description":"Server-generated. Read-only. True when custom JS/CSS variations are in use."},"hasTestContentOnsite":{"type":"boolean","description":"Server-generated. Read-only. True when visual onsite edit variations are in use."},"hasTestContentTemplate":{"type":"boolean","description":"Server-generated. Read-only. True when Shopify template variations are in use."},"hasTestContentTheme":{"type":"boolean","description":"Server-generated. Read-only. True when Shopify theme variations are in use."},"hasTestOnsiteInjections":{"type":"boolean","description":"Server-generated. Read-only. True when CSS/JS injection variations are in use."},"hasTestCheckoutBlocks":{"type":"boolean","description":"Server-generated. Read-only. True when checkout block variations are in use."},"hasTestPostPurchase":{"type":"boolean","description":"Server-generated. Read-only. True when post-purchase upsell variations are in use."}},"required":["hasTestPricing","hasTestShipping","hasTestCampaign","hasTestContent","hasTestContentUrl","hasTestContentAdvanced","hasTestContentOnsite","hasTestContentTemplate","hasTestContentTheme","hasTestOnsiteInjections","hasTestCheckoutBlocks","hasTestPostPurchase"],"additionalProperties":false,"description":"Server-generated. Read-only. Flags derived from 'type' indicating which variation capabilities are active."},"experiencePageTargeting":{"default":[],"description":"URL rules controlling which storefront pages this experience activates on. Empty means all pages.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"filter":{"anyOf":[{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},{"type":"null"}]},"filterType":{"default":"url","type":"string","enum":["utm","url","device","visitor","jsExpression","trafficSource","country","referrer","cookie"]},"value":{"type":"string"},"order":{"type":"number"},"expression":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"query":{"type":"object","properties":{"key":{"type":"string","description":"Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')."},"value":{"type":"string","description":"Expected value to compare against the visitor's actual value for this key."},"filter":{"description":"Comparison operator (e.g., equals, contains, startsWith).","anyOf":[{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},{"type":"null"}]},"type":{"default":"utm","description":"Category of the parameter being matched. Determines which keys are valid.","type":"string","enum":["utm","url","urlPath","device","visitor","jsExpression","trafficSource","country","referrer","cookie","klaviyo","landingPage"]}},"required":["key","value","type"],"additionalProperties":false},"operator":{"type":"string","enum":["and","or","start_paren","end_paren"]}},"additionalProperties":false}},{"type":"null"}]},"experienceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","filterType","value","order"],"additionalProperties":false}},"experienceProductTargeting":{"default":[],"description":"Product attribute rules controlling which products this experience applies to. Empty means all products.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"experienceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the parent experience."},"target":{"type":"string","enum":["productPage","productCard"],"description":"Storefront context where targeting rules are evaluated (product detail pages vs collection/search listings)."},"expression":{"description":"Boolean expression tree of product attribute conditions. Each node has either a 'query' (leaf) or 'operator' (combinator).","anyOf":[{"type":"array","items":{"type":"object","properties":{"query":{"type":"object","properties":{"key":{"type":"string","enum":["productId","collection","tag","price","inventory"],"description":"Product attribute to filter on. Determines which product property is evaluated."},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"Expected value. String for text attributes (productId, collection, tag); number for numeric attributes (price, inventory)."},"filter":{"type":"string","enum":["includes","doesNotInclude","greaterThan","lessThan"],"description":"Comparison operator for evaluating the product attribute against the value."},"type":{"type":"string","enum":["productId","collection","tag","price","inventory"],"description":"Mirrors the key field. Determines attribute category for validation."}},"required":["key","value","filter","type"],"additionalProperties":false},"operator":{"type":"string","enum":["and","or","start_paren","end_paren"]}},"additionalProperties":false}},{"type":"null"}]}},"required":["id","experienceId","target"],"additionalProperties":false}},"experienceActions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"experienceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"action":{"type":"string","enum":["start","pause","end","delete","reset"]},"actionTs":{"type":"number"},"performedBy":{"description":"Email of the user who triggered this lifecycle event. Resolved from History records by matching action type and timestamp within a 5-minute window. Null if no matching History record is found, or if the record has no associated user. Currently only populated by GET /experiences/{experienceId}; list endpoints return null.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","experienceId","action","actionTs"],"additionalProperties":false},"description":"Server-generated. Read-only. Lifecycle state transitions (start, pause, end, delete, reset) recorded for this experience. On GET /experiences/{experienceId}, each entry includes a `performedBy` field with the triggering user's email, resolved from History records (may be null if unresolvable). Distinct from the list endpoint's raw `history` field, which contains broader user-action records."},"experienceIntegrations":{"default":[],"description":"Connected third-party integrations (e.g., Google Analytics, Segment).","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAtTs":{"type":"number"},"integration":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","enum":["Recharge","StayAi","GrowLTV","OneClickUpsell","Google","Amped","Clarity","Hotjar","Heatmap","CustomApi","Klaviyo","Slack","Amplitude","Heap","Segment","IntelligemsAPI","IntelligemsMcp"]},"description":{"type":"string"},"enabled":{"type":"boolean"},"globalSettings":{},"apis":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"accessToken":{"type":"string"},"scopes":{"type":"array","items":{"type":"string","enum":["read_experiments","write_experiments","write_test_groups","read_integrations"]}},"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["id","name","accessToken","scopes","organization"],"additionalProperties":false}},"createdAtTs":{"type":"number"},"lastUpdateTs":{"type":"number"}},"required":["id","name","description","enabled","globalSettings","apis"],"additionalProperties":false},"experienceSettings":{},"enabled":{"default":false,"type":"boolean"}},"required":["id","createdAtTs","integration","experienceSettings","enabled"],"additionalProperties":false}},"experienceCustomMetrics":{"default":[],"description":"Custom event-based metrics tracked alongside standard key metrics.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"experienceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the parent experience."},"order":{"type":"number","description":"Display position in the analytics dashboard. 0-indexed."},"customEventId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the custom event definition configured in the organization's analytics settings."},"customEvent":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"identifier":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"eventCountLastDay":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastEventTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAtTs":{"type":"number"},"archivedAtTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"applyToUrls":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"matchBy":{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},"value":{"type":"string"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["matchBy","value"],"additionalProperties":false}},{"type":"null"}]},"experiencesList":{"anyOf":[{"default":[],"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","const":"pageView"},"settings":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","identifier","name","createdAtTs","type","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"identifier":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"eventCountLastDay":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastEventTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAtTs":{"type":"number"},"archivedAtTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"applyToUrls":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"matchBy":{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},"value":{"type":"string"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["matchBy","value"],"additionalProperties":false}},{"type":"null"}]},"experiencesList":{"anyOf":[{"default":[],"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","const":"productPageView"},"settings":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"handle":{"type":"string"}},"required":["productId","handle"],"additionalProperties":false}}},"required":["id","identifier","name","createdAtTs","type","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"identifier":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"eventCountLastDay":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastEventTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAtTs":{"type":"number"},"archivedAtTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"applyToUrls":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"matchBy":{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},"value":{"type":"string"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["matchBy","value"],"additionalProperties":false}},{"type":"null"}]},"experiencesList":{"anyOf":[{"default":[],"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","const":"collectionPageView"},"settings":{"type":"array","items":{"type":"object","properties":{"handle":{"type":"string"}},"required":["handle"],"additionalProperties":false}}},"required":["id","identifier","name","createdAtTs","type","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"identifier":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"eventCountLastDay":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastEventTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAtTs":{"type":"number"},"archivedAtTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"applyToUrls":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"matchBy":{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},"value":{"type":"string"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["matchBy","value"],"additionalProperties":false}},{"type":"null"}]},"experiencesList":{"anyOf":[{"default":[],"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","const":"clickEvent"},"settings":{"type":"object","properties":{"selectors":{"type":"array","items":{"type":"string"}}},"required":["selectors"],"additionalProperties":false}},"required":["id","identifier","name","createdAtTs","type","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"identifier":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"eventCountLastDay":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastEventTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAtTs":{"type":"number"},"archivedAtTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"applyToUrls":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"matchBy":{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},"value":{"type":"string"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["matchBy","value"],"additionalProperties":false}},{"type":"null"}]},"experiencesList":{"anyOf":[{"default":[],"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","const":"elementViewed"},"settings":{"type":"object","properties":{"selectors":{"type":"array","items":{"type":"string"}}},"required":["selectors"],"additionalProperties":false}},"required":["id","identifier","name","createdAtTs","type","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"identifier":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"eventCountLastDay":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastEventTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAtTs":{"type":"number"},"archivedAtTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"applyToUrls":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"matchBy":{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},"value":{"type":"string"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["matchBy","value"],"additionalProperties":false}},{"type":"null"}]},"experiencesList":{"anyOf":[{"default":[],"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","const":"scrollDepth"},"settings":{"type":"object","properties":{"mobile":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"additionalProperties":false},"desktop":{"type":"object","properties":{"percentage":{"type":"number"}},"required":["percentage"],"additionalProperties":false}},"required":["mobile","desktop"],"additionalProperties":false}},"required":["id","identifier","name","createdAtTs","type","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"identifier":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"eventCountLastDay":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastEventTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAtTs":{"type":"number"},"archivedAtTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"applyToUrls":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"matchBy":{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},"value":{"type":"string"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["matchBy","value"],"additionalProperties":false}},{"type":"null"}]},"experiencesList":{"anyOf":[{"default":[],"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","const":"javascriptEvent"},"settings":{"type":"object","properties":{"code":{"type":"string"}},"required":["code"],"additionalProperties":false}},"required":["id","identifier","name","createdAtTs","type","settings"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"identifier":{"type":"string"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"eventCountLastDay":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastEventTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAtTs":{"type":"number"},"archivedAtTs":{"anyOf":[{"type":"number"},{"type":"null"}]},"applyToUrls":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"matchBy":{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},"value":{"type":"string"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["matchBy","value"],"additionalProperties":false}},{"type":"null"}]},"experiencesList":{"anyOf":[{"default":[],"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","const":"javascriptImportedEvent"},"settings":{"type":"object","properties":{"registered":{"type":"boolean"}},"required":["registered"],"additionalProperties":false}},"required":["id","identifier","name","createdAtTs","type","settings"],"additionalProperties":false}],"description":"Server-generated. Read-only. Expanded custom event definition with name, tracking details, and configuration.","type":"object"}},"required":["id","experienceId","order","customEventId","customEvent"],"additionalProperties":false}},"experienceKeyMetrics":{"default":[],"description":"Business metrics (revenue, conversion, AOV, etc.) used to evaluate test performance. One must be primary.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"experienceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the parent experience."},"order":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Display position in the analytics dashboard. 0-indexed."},"isPrimary":{"default":false,"description":"The primary metric determines the main success signal for the test. Exactly one per experience.","type":"boolean"},"standardEventId":{"description":"Standard e-commerce event (e.g., revenue, conversion). Mutually exclusive with experienceCustomMetricId.","anyOf":[{"type":"string","enum":["conversionRate","addToCartRate","abandonedCartRate","abandonedCheckoutRate","checkoutBeginRate","checkoutEnterContactInfoRate","checkoutAddressSubmittedRate","viewProductPageRate","viewCollectionPageRate","netRevenuePerVisitor","netProductRevenuePerOrder","netRevenuePerOrder","avgUnitsPerOrder","avgProductRevenuePerUnit","profitPerVisitor","profitPerOrder","pctOrdersFreeShipping","netShippingRevenuePerOrder","subscriptionOrdersPerVisitor","subscriptionRevenuePerVisitor","subscriptionProfitPerVisitor","subscriptionProductRevenuePerOrder","avgDiscountPerDiscountedOrder","avgDiscountPerAllOrders","pctSubscriptionOrders","subscriptionRevenuePerOrder"]},{"type":"null"}]},"experienceCustomMetricId":{"description":"References a custom event metric. Mutually exclusive with standardEventId. Exactly one of these must be set.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","experienceId","order","isPrimary"],"additionalProperties":false}},"currency":{"description":"Currency settings for price display and analytics calculations. Null inherits store default.","anyOf":[{"type":"object","properties":{"code":{"default":"USD","description":"ISO 4217 currency code used for analytics and price calculations.","type":"string"},"country":{"description":"ISO country code for locale-specific formatting.","type":"string"},"options":{"description":"Additional locale-specific formatting options."},"symbol":{"default":"$","description":"Display symbol prepended to amounts (e.g., '$', '€').","type":"string"},"suffix":{"description":"Text appended after amounts for postfix currencies (e.g., 'kr' in '100 kr').","type":"string"}},"required":["code","symbol"],"additionalProperties":false},{"type":"null"}]},"variations":{"default":[],"description":"Test variants including the control. One must be control; traffic percentages must sum to 100.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"experienceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the parent experience."},"name":{"type":"string","description":"Display name (e.g., 'Control', 'Variant A'). Unique within the experience."},"percentage":{"type":"number","description":"Traffic allocation weight. All percentages across sibling variations must sum to 100."},"isControl":{"default":false,"description":"The baseline variation all others are measured against. Exactly one per experience.","type":"boolean"},"order":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Display order in the analytics dashboard. 0-indexed."},"priceChange":{"description":"Price adjustment amount for pricing-type experiences. Positive increases price, negative discounts. Use priceChange for simple price A/B tests; use offer for structured discount campaigns (tiered, BOGO, free shipping).","anyOf":[{"type":"string"},{"type":"null"}]},"priceChangeUnit":{"description":"How priceChange is applied: as a percentage of the original price or a fixed monetary amount.","anyOf":[{"type":"string","enum":["percent","dollar"]},{"type":"null"}]},"priceRoundingType":{"description":"Rounding strategy applied after priceChange (e.g., round up, round down, charm pricing).","anyOf":[{"type":"string","enum":["none","nearest","up","down"]},{"type":"null"}]},"priceRoundingAmount":{"description":"Target value for rounding (e.g., 0.99 for charm pricing like $X.99).","anyOf":[{"type":"string"},{"type":"null"}]},"onsiteEdits":{"default":[],"description":"DOM content modifications (text, HTML, image swaps, element removal). For CSS styling changes, use onsiteInjections instead.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"onsiteEditType":{"description":"Content modification strategy (html, text, image, or hide).","anyOf":[{"type":"string","enum":["html","text","image","hide"]},{"type":"null"}]},"variationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the parent variation."},"find":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pattern to locate on the page. Interpreted as regex when isRegex is true."},"title":{"description":"Dashboard label for identifying this edit.","anyOf":[{"type":"string"},{"type":"null"}]},"isRegex":{"default":false,"description":"When true, 'find' is treated as a regular expression.","type":"boolean"},"replace":{"default":"","description":"Replacement content. Interpretation depends on onsiteEditType: HTML markup, plain text, or image URL.","type":"string"},"querySelectors":{"default":[""],"description":"CSS selectors scoping which DOM elements this edit targets (e.g., '.product-title').","type":"array","items":{"type":"string"}},"skip":{"default":false,"description":"When true, this edit is temporarily disabled without being deleted.","type":"boolean"},"remove":{"default":false,"description":"When true, the matched element is removed from the DOM instead of having its content replaced.","type":"boolean"},"groupId":{"description":"Groups related edits together so they can be managed as a unit.","type":"string"},"isHtml":{"default":false,"type":"boolean"},"isImage":{"default":false,"type":"boolean"},"insertType":{"anyOf":[{"type":"string","enum":["beforebegin","afterbegin","beforeend","afterend"]},{"type":"null"}],"description":"DOM insertion position relative to the target (beforebegin, afterbegin, beforeend, afterend). Null means content replacement."},"createdAtUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Server-generated. Read-only. Storefront URL where this edit was originally created via the visual editor."},"createdAtTs":{"description":"Server-generated. Read-only. Unix timestamp in seconds.","anyOf":[{"type":"number"},{"type":"null"}]},"imageSearchUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"URL pathname for locating images to replace. When set, images are found by URL match; when null, querySelectors is used instead."},"source":{"anyOf":[{"type":"string","enum":["ai"]},{"type":"null"}]}},"required":["id","variationId","find","isRegex","replace","querySelectors","skip","remove","isHtml","isImage","insertType"],"additionalProperties":false}},"onsiteInjections":{"description":"CSS styling and custom JS injection. At most one per variation. For DOM content changes (text, images, HTML), use onsiteEdits instead.","anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"variationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the parent variation."},"customCss":{"description":"CSS injected globally on the page when this variation is active.","anyOf":[{"type":"string"},{"type":"null"}]},"customJs":{"description":"JavaScript executed on the page. Execution timing controlled by jsInjectionMode.","anyOf":[{"type":"string"},{"type":"null"}]},"jsInjectionMode":{"type":"object","properties":{"type":{"default":"immediately","description":"Execution timing for injected JS. When 'timeout', the timeout field specifies the delay.","type":"string","enum":["immediately","onWindowLoad","timeout"]},"timeout":{"description":"Delay in milliseconds before JS execution. Only relevant when type is 'timeout'.","anyOf":[{"type":"number"},{"type":"string"}]}},"required":["type"],"additionalProperties":false,"description":"Controls when customJs runs: immediately on load, after window load, or after a configurable delay."},"source":{"anyOf":[{"type":"string","enum":["ai"]},{"type":"null"}]}},"required":["id","variationId","jsInjectionMode"],"additionalProperties":false},{"type":"null"}]},"offer":{"description":"Structured discount configuration (tiered volume discounts, cart-level discounts, gift-with-purchase, free shipping). Use offer for campaign/discount experiences; use priceChange for simple price A/B tests.","anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"variationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the parent variation this offer belongs to."},"enabled":{"default":false,"description":"Whether the offer is actively applying discounts to customers on the storefront.","type":"boolean"},"isTest":{"default":false,"description":"When true, the offer exists in draft mode and is not applied to customers.","type":"boolean"},"isArchived":{"default":false,"description":"Whether the offer has been archived and is no longer active.","type":"boolean"},"name":{"type":"string","description":"Internal label for identifying the offer in dashboards."},"unitType":{"default":"dollar","description":"Threshold basis for tiered discounts: per-item quantity or monetary amount spent.","type":"string","enum":["unit","dollar"]},"discountType":{"default":"dollar","description":"How the discount value is calculated (e.g., percentage off, fixed amount off).","type":"string","enum":["percentage","dollar"]},"tiers":{"default":[],"description":"Volume discount tiers ordered by threshold ascending (e.g., buy 2 = 10% off, buy 3 = 15% off).","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"minimumUnits":{"default":1,"type":"number"},"maximumUnits":{"default":1,"type":"number"},"unitDiscount":{"default":1,"type":"number"},"discountTitle":{"default":null,"anyOf":[{"type":"string"},{"type":"null"}]},"giftWithPurchaseTitle":{"default":null,"anyOf":[{"type":"string"},{"type":"null"}]},"isFreeShipping":{"default":false,"type":"boolean"},"isGiftWithPurchase":{"default":false,"type":"boolean"},"giftWithPurchaseProductId":{"anyOf":[{"type":"string"},{"type":"null"}]},"giftWithPurchaseVariantId":{"anyOf":[{"type":"string"},{"type":"null"}]},"autoAddGiftWithPurchase":{"default":false,"type":"boolean"},"giftWithPurchaseHandle":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","minimumUnits","maximumUnits","unitDiscount","discountTitle","giftWithPurchaseTitle","isFreeShipping","isGiftWithPurchase","autoAddGiftWithPurchase"],"additionalProperties":false}},"maximumDollarDiscount":{"description":"Hard cap on the total dollar discount. Null means no cap is applied.","anyOf":[{"type":"number"},{"type":"null"}]},"discountApplicationType":{"type":"string","enum":["tieredDiscount","cartDiscount","freeGift","freeShipping",""],"description":"Core discount mechanic (tiered volume, flat cart-level, gift-with-purchase, or free shipping)."},"discountApplicationMethod":{"type":"string","enum":["perItem","perOrder"],"description":"Whether the discount applies per individual item or to the entire order."},"combinesWithIntelligems":{"type":"boolean","description":"Whether this offer stacks with other active Intelligems discounts."},"combinesWithShopify":{"type":"boolean","description":"Whether this offer stacks with native Shopify discount codes."},"shouldRejectCodes":{"type":"boolean","description":"When true, manual discount codes entered at checkout are rejected while this offer is active."},"shippingDiscount":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"discountType":{"type":"string","enum":["percentage","dollar"]},"unitDiscount":{"type":"number"},"rateFilter":{"anyOf":[{"anyOf":[{"type":"object","properties":{"type":{"type":"string","const":"amount"},"amount":{"type":"number"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"name"},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["is","contains","isNot","doesNotContain","startsWith","doesNotStartWith"]},"name":{"type":"string"}},"required":["id","operator","name"],"additionalProperties":false}}},"required":["type","rules"],"additionalProperties":false}]},{"type":"null"}]},"countryFilter":{"anyOf":[{"type":"object","properties":{"allow":{"type":"array","items":{"type":"string"}},"exclude":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},{"type":"null"}]},"discountLabel":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","discountType","unitDiscount","rateFilter","countryFilter","discountLabel"],"additionalProperties":false},{"type":"null"}],"description":"Shipping discount details. Only present when discountApplicationType is freeShipping."},"requireSameItem":{"default":false,"description":"For tiered discounts: when true, only multiples of the same product count toward thresholds.","type":"boolean"},"subscriptionApplicationType":{"default":"oneTime","description":"Controls which purchase types this offer applies to: 'oneTime' (one-time purchases only), 'firstSub' (first subscription orders only), or 'oneTimeAndFirstSub' (both one-time and first subscription orders).","type":"string","enum":["oneTime","firstSub","oneTimeAndFirstSub"]}},"required":["id","variationId","enabled","isTest","isArchived","name","unitType","discountType","tiers","discountApplicationType","discountApplicationMethod","combinesWithIntelligems","combinesWithShopify","shouldRejectCodes","shippingDiscount","requireSameItem","subscriptionApplicationType"],"additionalProperties":false},{"type":"null"}]},"offerId":{"description":"Server-generated. Read-only. References the associated offer. Populated when offer is set.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"shippingRateGroups":{"description":"Shipping rate overrides. Only populated for shipping test experiences.","default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"groupType":{"type":"string","enum":["flatRate","flatRateWithThreshold","thresholdOnly","tieredByPriceOrWeight","custom"]},"position":{"type":"number"},"rates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"amount":{"type":"number"},"rateCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"rateType":{"type":"string","enum":["amount","threshold","tier"]},"currency":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BIF","BMD","BND","BOB","BRL","BSD","BWP","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","ISK","JMD","JPY","KES","KGS","KHR","KMF","KRW","KYD","KZT","LAK","LBP","LKR","LRD","LSL","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLL","SRD","STD","SZL","THB","TJS","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW"]},"condition":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"min":{"default":0,"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}]},"max":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}]},"conditionType":{"type":"string","enum":["currency","weight"]},"unit":{"anyOf":[{"type":"string","enum":["g","kg","lb","oz"]},{"type":"null"}]}},"required":["min","conditionType"],"additionalProperties":false},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","amount","rateType","currency"],"additionalProperties":false}},"variationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","groupType","position","rates","variationId"],"additionalProperties":false}},"excludeProducts":{"description":"When true, specific products are excluded from price changes. Use excludeProducts when most products should be tested and only a few excluded. Mutually exclusive with includeProducts.","default":false,"type":"boolean"},"includeProducts":{"description":"When true, only specific products receive price changes. Use includeProducts when only a few products should be tested. Mutually exclusive with excludeProducts.","default":false,"type":"boolean"},"testExperienceId":{"description":"Links to another experience for advanced multi-experience configurations.","anyOf":[{"type":"string"},{"type":"null"}]},"functionSyncError":{"default":false,"description":"Server-generated. Read-only. Indicates a sync failure with Shopify Functions for this variation's discount.","type":"boolean"},"redirects":{"description":"URL redirect rules for content/url experiences.","default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"group":{"type":"number","description":"Numeric group for organizing related redirects. Redirects sharing an originUrl should share a group number."},"variationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the parent variation."},"originUrl":{"type":"string","description":"URL pattern matched against visitor page URLs. Matching behavior depends on the 'filter' field."},"destinationUrl":{"description":"Target URL visitors are sent to. Used when redirectType is 'fullReplacement'.","anyOf":[{"type":"string"},{"type":"null"}]},"queryParams":{"default":[],"description":"Key-value pairs appended to the destination URL as query parameters.","type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Query parameter name appended to the destination URL."},"value":{"type":"string","description":"Query parameter value."}},"required":["key","value"],"additionalProperties":false}},"skip":{"type":"boolean","description":"When true, this redirect is temporarily disabled."},"isThemeTest":{"type":"boolean","description":"True when this redirect tests alternate Shopify themes. Used with content/theme experiences."},"isTemplateTest":{"type":"boolean","description":"True when this redirect tests alternate Shopify templates. Used with content/template experiences."},"templateType":{"description":"Shopify template type being tested (e.g., product, collection).","anyOf":[{"type":"string","enum":["404","","article","blog","cart","collection","index","list-collections","page","password","product","search"]},{"type":"null"}]},"templateSuffixes":{"default":[],"description":"Alternate Shopify template suffixes being tested (e.g., 'alternate', 'new-layout').","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"redirectOnce":{"default":false,"description":"When true, the redirect fires only once per visitor session to avoid redirect loops.","type":"boolean"},"filter":{"default":"matchesExactly","description":"Matching strategy for originUrl (e.g., exact match, contains, endsWith, regex).","type":"string","enum":["matchesExactly","contains","endsWith","matchesRegex","none"]},"find":{"description":"Pattern to locate within the URL for partial replacement. Only used when redirectType is 'partialReplacement'.","anyOf":[{"type":"string"},{"type":"null"}]},"redirectType":{"default":"fullReplacement","description":"fullReplacement navigates to destinationUrl; partialReplacement swaps only the 'find' match within the current URL.","type":"string","enum":["fullReplacement","partialReplacement"]}},"required":["id","group","variationId","originUrl","queryParams","skip","isThemeTest","isTemplateTest","templateSuffixes","redirectOnce","filter","redirectType"],"additionalProperties":false}},"userInterfaces":{"description":"UI widget configurations displayed for this variation.","default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"isEnabled":{"type":"boolean"},"isArchived":{"default":false,"type":"boolean"},"widget":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"enabledSitewide":{"default":false,"type":"boolean"},"parentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"widgetType":{"type":"string","enum":["messageBoxPopup","messageBoxSlideOut","quantityButtons","discountProgressBar","shippingProgressBar"]},"config":{"type":"object","properties":{"desktop":{},"mobile":{}},"additionalProperties":false}},"required":["id","name","enabledSitewide","widgetType","config"],"additionalProperties":false},"widgetId":{"type":"string","minLength":1},"category":{"type":"string","enum":["quantityButtons","progressBar","messageBox"]},"variationId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"desktopVariables":{"anyOf":[{},{"type":"null"}]},"mobileVariables":{"anyOf":[{},{"type":"null"}]},"styleOverrides":{"anyOf":[{},{"type":"null"}]}},"required":["id","isArchived","widgetId"],"additionalProperties":false}},"checkoutBlocks":{"description":"Shopify checkout extensibility block configurations for this variation.","default":[],"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"variationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the parent variation."},"locationId":{"type":"string","description":"Shopify checkout extensibility target location where the block renders."},"blockType":{"type":"string","const":"trustBadge"},"name":{"type":"string","description":"Display name for identifying this block in the dashboard."},"variables":{"type":"object","properties":{"headerText":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"order":{"type":"number"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"type":"string"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}]},"iconColor":{"anyOf":[{"type":"string"},{"type":"null"}]},"iconSize":{"anyOf":[{"type":"string"},{"type":"null"}]},"imageSize":{"anyOf":[{"type":"number","minimum":1,"maximum":500},{"type":"null"}]},"imageSizeUnit":{"type":"string","enum":["pixels","percentage"]},"imageAspectRatio":{"anyOf":[{"type":"string"},{"type":"null"}]},"image":{"anyOf":[{"type":"string"},{"type":"null"}]},"mediaSpacing":{"type":"string"}},"required":["order","type","imageSize","imageSizeUnit","mediaSpacing"],"additionalProperties":false}}},"required":["headerText","items"],"additionalProperties":false,"description":"Configurable content for the trust badge (e.g., badge images, guarantee text)."},"styles":{"type":"object","properties":{"typography":{"type":"object","properties":{"header":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false},"itemTitle":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false},"itemSubtitle":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false}},"required":["header","itemTitle","itemSubtitle"],"additionalProperties":false},"backgroundColors":{"type":"object","properties":{"header":{"type":"string"},"item":{"type":"string"},"block":{"type":"string"}},"required":["header","item","block"],"additionalProperties":false},"colors":{"type":"object","properties":{"headerText":{"type":"string"},"itemTitleText":{"type":"string"},"itemSubtitleText":{"type":"string"}},"required":["headerText","itemTitleText","itemSubtitleText"],"additionalProperties":false},"layout":{"type":"object","properties":{"headerTextAlign":{"type":"string"},"bodyAlign":{"type":"string"},"itemTextAlign":{"type":"string"},"itemPositionAlign":{"type":"string"},"rowCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"columnCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["headerTextAlign","bodyAlign","itemTextAlign","itemPositionAlign","rowCount","columnCount"],"additionalProperties":false},"appearance":{"type":"object","properties":{"headerBorderThickness":{"type":"string"},"headerBorderStyle":{"default":"none","type":"string"},"headerCornerRadius":{"type":"string"},"headerPadding":{"type":"string"},"bodySpacing":{"type":"string"},"headingToBodySpacing":{"type":"string"},"blockBorderThickness":{"type":"string"},"blockBorderStyle":{"default":"none","type":"string"},"blockPadding":{"type":"string"},"blockCornerRadius":{"type":"string"},"itemBorderThickness":{"type":"string"},"itemBorderStyle":{"default":"none","type":"string"},"itemCornerRadius":{"type":"string"},"itemTextSpacing":{"type":"string"}},"required":["headerBorderThickness","headerBorderStyle","headerCornerRadius","headerPadding","bodySpacing","headingToBodySpacing","blockBorderThickness","blockBorderStyle","blockPadding","blockCornerRadius","itemBorderThickness","itemBorderStyle","itemCornerRadius","itemTextSpacing"],"additionalProperties":false}},"required":["typography","backgroundColors","colors","layout","appearance"],"additionalProperties":false,"description":"CSS styling overrides for the trust badge appearance."}},"required":["id","variationId","locationId","blockType","name","variables","styles"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"variationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the parent variation."},"locationId":{"type":"string","description":"Shopify checkout extensibility target location where the block renders."},"blockType":{"type":"string","const":"upsell"},"name":{"type":"string","description":"Display name for identifying this block in the dashboard."},"variables":{"type":"object","properties":{"headerText":{"type":"string"},"maxProductLimit":{"default":3,"type":"integer","minimum":1,"maximum":10},"excludeItemsInCart":{"default":false,"type":"boolean"},"excludeOutOfStock":{"default":false,"type":"boolean"},"buttonText":{"type":"string"},"imageSize":{"type":"number","minimum":1,"maximum":500},"imageSizeUnit":{"type":"string","enum":["pixels","percentage"]},"imageAspectRatio":{"type":"string"},"mediaSpacing":{"type":"string"}},"required":["headerText","maxProductLimit","excludeItemsInCart","excludeOutOfStock","buttonText","imageSize","imageSizeUnit","imageAspectRatio","mediaSpacing"],"additionalProperties":false,"description":"Configurable content for the upsell block (e.g., product selection, heading text, CTA label)."},"styles":{"type":"object","properties":{"typography":{"type":"object","properties":{"header":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false},"productTitle":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false},"variantTitle":{"default":{"fontSize":"base","fontStyle":"normal"},"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false},"price":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false},"button":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false}},"required":["header","productTitle","variantTitle","price","button"],"additionalProperties":false},"backgroundColors":{"type":"object","properties":{"header":{"type":"string"},"item":{"type":"string"},"block":{"type":"string"},"button":{"type":"string"},"productUnit":{"type":"string"}},"required":["header","item","block","button","productUnit"],"additionalProperties":false},"colors":{"type":"object","properties":{"headerText":{"type":"string"},"productText":{"type":"string"},"variantText":{"default":"subdued","type":"string"},"priceText":{"type":"string"},"carouselArrowColor":{"default":"monochrome","type":"string"},"carouselArrowStyle":{"default":"primary","type":"string"}},"required":["headerText","productText","variantText","priceText","carouselArrowColor","carouselArrowStyle"],"additionalProperties":false},"layout":{"type":"object","properties":{"headerTextAlign":{"type":"string"},"bodyAlign":{"type":"string"},"itemTextAlign":{"type":"string"},"itemPositionAlign":{"type":"string"},"mobile":{"type":"object","properties":{"rowCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"columnCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rowCount","columnCount"],"additionalProperties":false},"desktop":{"type":"object","properties":{"rowCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"columnCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rowCount","columnCount"],"additionalProperties":false}},"required":["headerTextAlign","bodyAlign","itemTextAlign","itemPositionAlign","mobile","desktop"],"additionalProperties":false},"appearance":{"type":"object","properties":{"headerBorderThickness":{"type":"string"},"headerBorderStyle":{"default":"none","type":"string"},"headerCornerRadius":{"type":"string"},"headerPadding":{"type":"string"},"bodySpacing":{"type":"string"},"headingToBodySpacing":{"type":"string"},"blockBorderThickness":{"type":"string"},"blockBorderStyle":{"default":"none","type":"string"},"blockPadding":{"type":"string"},"blockCornerRadius":{"type":"string"},"productBorderThickness":{"type":"string"},"productBorderStyle":{"default":"none","type":"string"},"productCornerRadius":{"type":"string"},"productTextSpacing":{"type":"string"}},"required":["headerBorderThickness","headerBorderStyle","headerCornerRadius","headerPadding","bodySpacing","headingToBodySpacing","blockBorderThickness","blockBorderStyle","blockPadding","blockCornerRadius","productBorderThickness","productBorderStyle","productCornerRadius","productTextSpacing"],"additionalProperties":false}},"required":["typography","backgroundColors","colors","layout","appearance"],"additionalProperties":false,"description":"CSS styling overrides for the upsell block appearance."},"upsellProductRules":{"default":[],"description":"Product selection and recommendation rules that determine which products to show in this upsell block.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"checkoutBlockId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priority":{"type":"integer","minimum":0,"maximum":9007199254740991},"cartTargeting":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expression":{"type":"array","items":{"type":"object","properties":{"query":{"type":"object","properties":{"key":{"type":"string","enum":["anything","productId","collection","tag","cartSubtotal","cartItemCount"]},"type":{"type":"string","enum":["anything","productId","collection","tag","cartSubtotal","cartItemCount"]},"filter":{"type":"string","enum":["includes","doesNotInclude","greaterThan","lessThan","equalTo","greaterThanOrEqual","lessThanOrEqual","between"]},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"object","properties":{"variantId":{"type":"string"},"inclusionType":{"type":"string","enum":["include","exclude"]}},"required":["variantId","inclusionType"],"additionalProperties":false}}}]}},"required":["key","type","filter"],"additionalProperties":false},"operator":{"type":"string","enum":["and","or","start_paren","end_paren"]}},"additionalProperties":false}}},"required":["id","expression"],"additionalProperties":false},"action":{"$ref":"#/components/schemas/__schema0"},"variationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","checkoutBlockId","priority","cartTargeting","action","variationId"],"additionalProperties":false}}},"required":["id","variationId","locationId","blockType","name","variables","styles","upsellProductRules"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"variationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the parent variation."},"locationId":{"type":"string","description":"Shopify checkout extensibility target location where the block renders."},"blockType":{"type":"string","const":"postPurchaseUpsell"},"name":{"type":"string","description":"Display name for identifying this block in the dashboard."},"variables":{"type":"object","properties":{"headerText":{"type":"string"},"discountType":{"default":"none","type":"string","enum":["none","percentage","fixed"]},"discountValue":{"anyOf":[{"type":"number"},{"type":"null"}]},"compareAtPriceDisplay":{"default":"none","type":"string","enum":["none","compareAtPrice","regularPrice"]},"imageAspectRatio":{"type":"string"},"excludeOutOfStock":{"type":"boolean"},"excludeItemsInCart":{"type":"boolean"},"maxProductLimit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bannerEnabled":{"type":"boolean"},"bannerTitle":{"type":"string"},"bannerSubtitle":{"type":"string"},"compareAtPriceEnabled":{"type":"boolean"},"descriptionEnabled":{"type":"boolean"},"quantitySelectorEnabled":{"type":"boolean"},"quantityLabel":{"type":"string"},"maxQuantityType":{"type":"string"},"maxQuantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"moneyLineEnabled":{"type":"boolean"},"moneyLineSubtotal":{"type":"boolean"},"moneyLineShipping":{"type":"boolean"},"moneyLineTaxes":{"type":"boolean"},"primaryButtonText":{"type":"string"},"secondaryButtonEnabled":{"type":"boolean"},"secondaryButtonText":{"type":"string"},"headingLevel":{"type":"string"}},"required":["headerText","discountType","compareAtPriceDisplay","imageAspectRatio","excludeOutOfStock","excludeItemsInCart","maxProductLimit","bannerEnabled","compareAtPriceEnabled","descriptionEnabled","quantitySelectorEnabled","moneyLineEnabled","moneyLineSubtotal","moneyLineShipping","moneyLineTaxes","primaryButtonText","secondaryButtonEnabled","headingLevel"],"additionalProperties":false},"styles":{"type":"object","properties":{"typography":{"type":"object","properties":{"banner":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false},"productTitle":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false},"price":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false},"description":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false},"primaryButton":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false},"secondaryButton":{"type":"object","properties":{"fontSize":{"type":"string"},"fontStyle":{"type":"string"}},"required":["fontSize","fontStyle"],"additionalProperties":false}},"required":["productTitle","price","primaryButton"],"additionalProperties":false},"backgroundColors":{"type":"object","properties":{"banner":{"type":"string"},"primaryButton":{"type":"string"},"secondaryButton":{"type":"string"}},"required":["banner","primaryButton"],"additionalProperties":false},"colors":{"type":"object","properties":{"bannerText":{"type":"string"},"productText":{"type":"string"},"priceText":{"type":"string"},"descriptionText":{"type":"string"},"primaryButtonText":{"type":"string"},"secondaryButtonText":{"type":"string"}},"required":["productText","priceText","primaryButtonText"],"additionalProperties":false},"appearance":{"type":"object","properties":{"bannerBorderStyle":{"type":"string"},"bannerSpacing":{"type":"string"},"bannerTextAlign":{"type":"string"},"separatorWidth":{"type":"string"},"imageFit":{"type":"string"},"imageBorder":{"type":"boolean"},"pricingAppearance":{"type":"string"},"pricingEmphasized":{"type":"boolean"},"pricingSubduedStyle":{"type":"boolean"},"descriptionSubdued":{"type":"boolean"},"secondaryButtonStyle":{"type":"string"}},"required":["bannerBorderStyle","bannerSpacing","bannerTextAlign","separatorWidth","imageFit","imageBorder","pricingEmphasized","descriptionSubdued","secondaryButtonStyle"],"additionalProperties":false}},"required":["typography","backgroundColors","colors","appearance"],"additionalProperties":false},"upsellProductRules":{"default":[],"description":"Product selection and recommendation rules that determine which products to show in this upsell block.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"checkoutBlockId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priority":{"type":"integer","minimum":0,"maximum":9007199254740991},"cartTargeting":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expression":{"type":"array","items":{"type":"object","properties":{"query":{"type":"object","properties":{"key":{"type":"string","enum":["anything","productId","collection","tag","cartSubtotal","cartItemCount"]},"type":{"type":"string","enum":["anything","productId","collection","tag","cartSubtotal","cartItemCount"]},"filter":{"type":"string","enum":["includes","doesNotInclude","greaterThan","lessThan","equalTo","greaterThanOrEqual","lessThanOrEqual","between"]},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"object","properties":{"variantId":{"type":"string"},"inclusionType":{"type":"string","enum":["include","exclude"]}},"required":["variantId","inclusionType"],"additionalProperties":false}}}]}},"required":["key","type","filter"],"additionalProperties":false},"operator":{"type":"string","enum":["and","or","start_paren","end_paren"]}},"additionalProperties":false}}},"required":["id","expression"],"additionalProperties":false},"action":{"$ref":"#/components/schemas/__schema0"},"variationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","checkoutBlockId","priority","cartTargeting","action","variationId"],"additionalProperties":false}}},"required":["id","variationId","locationId","blockType","name","variables","styles","upsellProductRules"],"additionalProperties":false}],"type":"object"}},"cartTargeting":{"description":"Cart-based targeting rules that determine when this variation is shown based on cart contents.","default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"expression":{"type":"array","items":{"type":"object","properties":{"query":{"type":"object","properties":{"key":{"type":"string","enum":["anything","productId","collection","tag","cartSubtotal","cartItemCount"]},"type":{"type":"string","enum":["anything","productId","collection","tag","cartSubtotal","cartItemCount"]},"filter":{"type":"string","enum":["includes","doesNotInclude","greaterThan","lessThan","equalTo","greaterThanOrEqual","lessThanOrEqual","between"]},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"object","properties":{"variantId":{"type":"string"},"inclusionType":{"type":"string","enum":["include","exclude"]}},"required":["variantId","inclusionType"],"additionalProperties":false}}}]}},"required":["key","type","filter"],"additionalProperties":false},"operator":{"type":"string","enum":["and","or","start_paren","end_paren"]}},"additionalProperties":false}}},"required":["id","expression"],"additionalProperties":false}}},"required":["id","experienceId","name","percentage","isControl","order","onsiteEdits","functionSyncError"],"additionalProperties":false}},"createdAtTs":{"type":"number","description":"Server-generated. Read-only. Unix timestamp in seconds."},"isDeleted":{"description":"Whether this experience has been soft-deleted and hidden from default listings.","type":"boolean"},"shippingTestMethodDefinitions":{"default":[],"description":"Shipping rate configurations. Only populated for shipping test experiences.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deliveryProfileId":{"type":"string"},"deliveryLocationGroupId":{"type":"string"},"deliveryZoneId":{"type":"string"},"methodDefinitionId":{"anyOf":[{"type":"string"},{"type":"null"}]},"canonicalMethodId":{"type":"string"},"deleteTargetKind":{"type":"string","enum":["canonical_method","participant_method","synthetic_free_condition","synthetic_rate_definition"]},"deleteTargetRateDefinitionId":{"type":"string"},"deleteTargetFreeCondition":{"type":"object","properties":{"subject":{"type":"string"},"min":{"anyOf":[{"anyOf":[{"type":"object","properties":{"__typename":{"type":"string","const":"MoneyV2"},"amount":{"type":"string"},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["__typename","amount"],"additionalProperties":false},{"type":"object","properties":{"__typename":{"type":"string","const":"Weight"},"unit":{"type":"string"},"value":{"type":"number"}},"required":["__typename","unit","value"],"additionalProperties":false}]},{"type":"null"}]},"max":{"anyOf":[{"anyOf":[{"type":"object","properties":{"__typename":{"type":"string","const":"MoneyV2"},"amount":{"type":"string"},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["__typename","amount"],"additionalProperties":false},{"type":"object","properties":{"__typename":{"type":"string","const":"Weight"},"unit":{"type":"string"},"value":{"type":"number"}},"required":["__typename","unit","value"],"additionalProperties":false}]},{"type":"null"}]}},"required":["subject"],"additionalProperties":false}},"required":["deliveryProfileId","deliveryLocationGroupId","deliveryZoneId"],"additionalProperties":false}},"audience":{"description":"Visitor segmentation rules. Null means all visitors are eligible.","anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"experienceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"References the parent experience."},"enabled":{"type":"boolean","description":"When false, audience rules are ignored and all visitors are eligible."},"excludeCurrency":{"type":"object","properties":{"exclude":{"type":"boolean","description":"Whether currency/geo-based exclusion is active."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO 4217 currency code to exclude. Null disables currency-based exclusion."},"country":{"description":"ISO country code to exclude visitors from.","type":"string"},"region":{"description":"Region or state code to exclude visitors from.","type":"string"},"city":{"description":"City name to exclude visitors from.","type":"string"}},"required":["exclude","currency"],"additionalProperties":false,"description":"Currency and geo-based visitor exclusion configuration."},"wholesale":{"type":"boolean","description":"Controls whether wholesale (B2B) customers are included in or excluded from the experience."},"audienceType":{"description":"Complexity level of the targeting rules: common (prebuilt), custom (simple), or advanced (full expression trees).","type":"string","enum":["common","custom","advanced"]},"elseAction":{"anyOf":[{"type":"string","enum":["experienceInclude","experienceExclude","experienceUnassigned","assignVariation","randomVariation","leaveUnassigned"]},{"type":"null"}],"description":"Fallback for visitors matching no filter: 'randomVariation' assigns randomly across variations (most common), 'assignVariation' forces a specific variation (set elseVariationId), 'experienceExclude' removes them from the experience entirely, 'leaveUnassigned' skips assignment."},"elseVariationId":{"description":"Variation to force-assign when elseAction is 'assignVariation'. Typically set to the control variation to default non-targeted visitors to baseline.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"elseExcludeFromAnalytics":{"default":false,"description":"When true, visitors who match no filter are tracked but excluded from analytics calculations.","type":"boolean"},"filters":{"default":[],"description":"Ordered filter rules evaluated from lowest priority value first (0-indexed). First matching filter determines visitor treatment.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Server-generated. Read-only."},"priority":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Evaluation order. 0-indexed. Filters with lower values are evaluated first."},"action":{"anyOf":[{"type":"string","enum":["experienceInclude","experienceExclude","experienceUnassigned","assignVariation","randomVariation","leaveUnassigned"]},{"type":"null"}],"description":"What happens when a visitor matches this filter: 'assignVariation' forces a specific variation (set variationId), 'experienceExclude' removes from the experience, 'randomVariation' assigns randomly."},"filterType":{"type":"string","enum":["utm","url","urlPath","device","visitor","jsExpression","trafficSource","country","referrer","cookie","klaviyo","landingPage"],"description":"Category of targeting rule (e.g., UTM parameters, device type, visitor type)."},"expression":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"query":{"type":"object","properties":{"key":{"type":"string","description":"Visitor attribute or parameter name to match (e.g., 'utm_source', 'device_type')."},"value":{"type":"string","description":"Expected value to compare against the visitor's actual value for this key."},"filter":{"description":"Comparison operator (e.g., equals, contains, startsWith).","anyOf":[{"type":"string","enum":["equals","contains","startsWith","endsWith","doesNotEqual","doesNotContain","doesNotStartWith","doesNotEndWith","isNull","isNotNull","regex"]},{"type":"null"}]},"type":{"default":"utm","description":"Category of the parameter being matched. Determines which keys are valid.","type":"string","enum":["utm","url","urlPath","device","visitor","jsExpression","trafficSource","country","referrer","cookie","klaviyo","landingPage"]}},"required":["key","value","type"],"additionalProperties":false},"operator":{"type":"string","enum":["and","or","start_paren","end_paren"]}},"additionalProperties":false}},{"type":"null"}],"description":"Boolean expression tree. Each node has either a 'query' (leaf condition) or 'operator' (logical combinator), not both."},"expressionType":{"description":"Whether this uses prebuilt common rules or custom expression logic.","anyOf":[{"type":"string","enum":["common","custom"]},{"type":"null"}]},"variationId":{"description":"Variation to assign when action is 'assignVariation'. References a variation in the parent experience.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"excludeFromAnalytics":{"default":false,"description":"When true, visitors matching this filter are excluded from analytics even if included in the experience.","type":"boolean"}},"required":["id","priority","action","filterType","excludeFromAnalytics"],"additionalProperties":false}},"evaluationFrequency":{"description":"How often (in seconds) to re-evaluate audience rules for a returning visitor. Controls targeting freshness.","anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","experienceId","enabled","excludeCurrency","wholesale","elseAction","elseExcludeFromAnalytics","filters"],"additionalProperties":false},{"type":"null"}]},"lastUpdateTs":{"type":"number","description":"Server-generated. Read-only. Unix timestamp in seconds of the most recent modification."},"previewPath":{"description":"Storefront URL path used when generating preview links (e.g., '/products/example').","anyOf":[{"type":"string"},{"type":"null"}]},"isExternal":{"description":"True if this experience was created and is managed via the external API rather than the dashboard.","anyOf":[{"default":false,"type":"boolean"},{"type":"null"}]},"startedAtTs":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Server-generated. Read-only. Unix timestamp in seconds. Null if never started."},"pausedAtTs":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Server-generated. Read-only. Unix timestamp in seconds. Null if not currently paused."},"archivedAtTs":{"description":"Server-generated. Read-only. Unix timestamp in seconds. Null if not archived.","anyOf":[{"type":"number"},{"type":"null"}]},"requiresLink":{"default":false,"description":"When true, visitors must use a special link to enter the experience instead of being auto-assigned.","type":"boolean"},"linkBaseUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Base URL for generating access links. Only populated when requiresLink is true."},"endedAtTs":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Server-generated. Read-only. Unix timestamp in seconds. Null if still active."},"productVariantCount":{"default":0,"description":"Server-generated. Read-only. Total product variants currently included in this experience.","type":"number"},"sourceExperienceId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"Present when this experience was duplicated or rolled out from another. References the original."},"sourceAction":{"anyOf":[{"type":"string","enum":["duplicate","rollout"]},{"type":"null"}],"description":"How this experience was derived from sourceExperienceId. Only present when sourceExperienceId is set."},"experienceAnalysis":{"type":"object","properties":{"analyticsViewType":{"type":"string","enum":["test_orders_only","sitewide_orders","none"],"description":"Scope of orders included in analytics results. Determines whether only tested products or all store orders are counted."}},"required":["analyticsViewType"],"additionalProperties":false}},"required":["id","name","isPreview","organizationId","type","category","status","testTypes","experiencePageTargeting","experienceProductTargeting","experienceActions","experienceIntegrations","experienceCustomMetrics","experienceKeyMetrics","variations","createdAtTs","shippingTestMethodDefinitions","lastUpdateTs","startedAtTs","pausedAtTs","requiresLink","linkBaseUrl","endedAtTs","productVariantCount","experienceAnalysis"],"additionalProperties":false,"description":"Full single-experience payload returned by GET /experiences/{experienceId}. Includes `experienceCustomMetrics`, `experienceIntegrations`, `experienceKeyMetrics`, and `shippingTestMethodDefinitions`. Unlike GET /experiences-list items, this response does not include `history`."}},"required":["experience"],"additionalProperties":false}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.intelligems.io/developer-resources/external-api/create-experience.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.