--- title: "List rules" method: GET path: "/em-rules" tags: ["Rule Management"] --- # List rules `GET /em-rules` List all rules with optional filtering and pagination. Note that sorting applies to the rule's staging content only. Filtering applies OR logic, matching if either the staging or live content matches the filter. Use `textSearchRelevance` sort to sort by search relevance (cannot be combined with other sort parameters). ## Query parameters - `searchQuery` string - `tags` string[] - `groups` string[] - `types` string[] - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' - `published` boolean - `targetedDocumentId` string - `targetedDocumentIdField` string - `activeDateStart` string, date-time - `activeDateEnd` string, date-time - `expirationDateStart` string, date-time - `expirationDateEnd` string, date-time - `lastModifiedStart` string, date-time - `lastModifiedEnd` string, date-time - `createdStart` string, date-time - `createdEnd` string, date-time - `contentType` 'RULE' | 'QUERY_REWRITE' - `page` integer - `size` integer - `sort` string[] - `fields` string[] ## Response `200` OK - PagedModelRuleSummary - `content` union[] - union - BannerRuleSummary — Displays a banner in the search results when rule criteria match. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - `queries` string[] — Sets of search terms that triggers this rule. Matching logic depends on the `matchSearchQueryUsing` value. - `fieldValues` FieldValueSummary[] — Determines which filters (`fq` parameters), when specified, will trigger this rule (for example when a query has an `fq` parameter with a value of `category:Shirts`). - `name` string, required - `value` string, required - `queryProfiles` string[] — Query profile IDs for which this rule can trigger. - `effectiveStart` string, date-time — Together with `effectiveEnd`, determines the time frame in which this rule is active. Either can be null to indicate no limit in that direction. - `effectiveEnd` string, date-time — Together with `effectiveStart`, determines the time frame in which this rule is active. Either can be null to indicate no limit in that direction. - `conflicts` union[] — Rules with conflicting/overlapping conditions. - union - BannerRuleSummary — recursive - BlockByAttributeRuleSummary — Blocks one or more documents that match the rule criteria in the search results, where rule criteria is an attribute (for example, `Color`) and list of values to block. - … - BlockListRuleSummary — Blocks one or more documents that match the rule criteria from appearing in the search results, where rule criteria is a field (for example, `id`) and list of values to block. - … - BoostAttributesRuleSummary — Boosts by either simple format (`boostParam`/`boostQuery`) or structured format (`block_groups_list`). When `block_groups_list` is present, it takes precedence over `boostParam`/`boostQuery`. - … - BoostListRuleSummary — Boosts one or more documents that match the rule criteria in the search results where rule criteria is a field (for example, `id`) and list of values to boost. - … - BuryAttributesRuleSummary — Buries documents by either `bq` or by boosting documents that match a user-supplied query. - … - BuryListRuleSummary — Downweights one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, `id`) and list of values to bury. - … - FilterListRuleSummary — Filters one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, `id`) and list of values to boost. - … - InGroupBoostListRuleSummary — Boosts one or more documents within its group in the search response. - … - InGroupBuryListRuleSummary — Buries one or more documents within its group in the search response. - … - InGroupPinRuleSummary — Like `InGroupBoostListRule`, but pins a document within a group to a specific position. - … - JsonBlobRuleSummary — Returns an arbitrary JSON blob alongside the response. - … - PinRuleSummary — Details about the pin rule. Boosts documents and then pins the matching values to absolute positions in the result set. - … - RedirectRuleSummary — Returns a URL for the redirect when this rule is triggered. - … - ResponseValueRuleSummary — Common properties shared by all rule summary types. - … - SetJSONFacetsRuleSummary — Details about the set JSON facets rule. Configure JSON facet API parameters for the current query. - … - SetParamsRuleSummary — Modify the parameters of the current request. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - `version` string, date-time — Current latest version of this content (timestamp taken when this content was last changed). This is not guaranteed to be the same as the `lastModified` time and should not be used as the Entity Tag (ETag) version, as this tracks when this individual rule content (staging or live) was changed, regardless of whether the rule itself was changed. For example, this version wouldn't be updated when this is the staging state of the rule and the live version of this rule's content is changed. - `lastSyncedVersion` string, date-time — Version of this content that was last successfully synced. - `fusionVersion` string — Version received when the last successful sync was performed. This value comes from the underlying search engine's optimistic concurrency mechanism. - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - `sourceId` string, uuid — The ID of the original rule in the source Commerce Studio instance. - `sourceEmInstanceId` string, uuid — The ID of the source Commerce Studio instance where the rule was migrated from. - `sourceBulkOperationId` string, uuid — The ID of the bulk operation that migrated this rule from the source Commerce Studio instance. - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - `key` string, required - `value` string, required - `segments` SegmentSummary[] — The segments that this rule will apply to. - `id` string, uuid — Entity ID. - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `lastModifiedBy` string — User who last updated the entity. - `lastModified` string, date-time — Date when the entity was last updated. - `name` string — Entity name. - `value` string — Value used at query time to target this segment. Cannot be changed after creation. - `type` string — Arbitrary categorization of the segment. - `ruleCount` integer — Number of rules associated with this segment, via either the rule's staging or live content. - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - BannerRuleSummary — recursive - BlockByAttributeRuleSummary — Blocks one or more documents that match the rule criteria in the search results, where rule criteria is an attribute (for example, `Color`) and list of values to block. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `termsQuerySeparator` string — Separator delimiting the values in the terms query string, defaulting to a comma. - `termsQueryMethod` 'termsFilter' | 'booleanQuery' | 'automaton' | 'docValuesTermsFilter' — Solr query execution method for matching terms. - `termsFilter` (default): Uses BooleanQuery or TermInSetQuery based on term count. Scales well with index size, moderately with number of terms. - `booleanQuery`: Creates a BooleanQuery. Scales well with index size, poorly with many terms. - `automaton`: Creates an AutomatonQuery. Scales well with index size and moderately with number of terms. - `docValuesTermsFilter`: Requires docValues-enabled fields. Automatically chooses optimal strategy based on term count. - `blockGroupsList` BlockGroupsChainSummary[] — A list of block group chains combined with OR logic. Each chain contains `block_groups` (conditions with AND/OR logic) and an optional `boost_factor` (ignored for blocking). Multiple chains are ORed together. Supports `EQUAL`, `GREATER_THAN`, `LESS_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`, `BETWEEN`, `NOT_EQUAL` operators. - … - BlockListRuleSummary — Blocks one or more documents that match the rule criteria from appearing in the search results, where rule criteria is a field (for example, `id`) and list of values to block. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `termsQuerySeparator` string — Separator delimiting the values in the terms query string, defaulting to a comma. - `termsQueryMethod` 'termsFilter' | 'booleanQuery' | 'automaton' | 'docValuesTermsFilter' — Solr query execution method for matching terms. - `termsFilter` (default): Uses BooleanQuery or TermInSetQuery based on term count. Scales well with index size, moderately with number of terms. - `booleanQuery`: Creates a BooleanQuery. Scales well with index size, poorly with many terms. - `automaton`: Creates an AutomatonQuery. Scales well with index size and moderately with number of terms. - `docValuesTermsFilter`: Requires docValues-enabled fields. Automatically chooses optimal strategy based on term count. - BoostAttributesRuleSummary — Boosts by either simple format (`boostParam`/`boostQuery`) or structured format (`block_groups_list`). When `block_groups_list` is present, it takes precedence over `boostParam`/`boostQuery`. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `boostParam` string — The boost param to use, either: bq (additive) or boost (multiplicative). Part of simple format, ignored when `blockGroupsList` is present. - `boostQuery` string — The boost query to use. Part of simple format, ignored when `blockGroupsList` is present. - `blockGroupsList` BlockGroupsChainSummary[] — A list of block group chains combined with OR logic. Each chain contains `block_groups` (conditions with AND/OR logic) and a `boost_factor`. Multiple chains are ORed together, each with its own boost factor. When present, this takes precedence over `boostParam`/`boostQuery`. - … - BoostListRuleSummary — Boosts one or more documents that match the rule criteria in the search results where rule criteria is a field (for example, `id`) and list of values to boost. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `useQec` boolean — Set to `true` to use query elevation to force-elevate documents to the top. Query elevation only supports elevation through the `id` field. Failure to configure query elevation correctly while having this box checked will cause this rule to stop working. - BuryAttributesRuleSummary — Buries documents by either `bq` or by boosting documents that match a user-supplied query. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `boostParam` string — The boost param to use, either: bq (additive) or boost (multiplicative). - `boostQuery` string — The boost query to use. Use a negative boost value to decrease the score and bury matching documents. - BuryListRuleSummary — Downweights one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, `id`) and list of values to bury. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - FilterListRuleSummary — Filters one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, `id`) and list of values to boost. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `useQec` boolean — Set to `true` to use query elevation to force-elevate documents to the top. Query elevation only supports elevation through the `id` field. Failure to configure query elevation correctly while having this box checked will cause this rule to stop working. - `termsQuerySeparator` string — Separator delimiting the values in the terms query string, defaulting to a comma. - `termsQueryMethod` 'termsFilter' | 'booleanQuery' | 'automaton' | 'docValuesTermsFilter' — Solr query execution method for matching terms. - `termsFilter` (default): Uses BooleanQuery or TermInSetQuery based on term count. Scales well with index size, moderately with number of terms. - `booleanQuery`: Creates a BooleanQuery. Scales well with index size, poorly with many terms. - `automaton`: Creates an AutomatonQuery. Scales well with index size and moderately with number of terms. - `docValuesTermsFilter`: Requires docValues-enabled fields. Automatically chooses optimal strategy based on term count. - InGroupBoostListRuleSummary — Boosts one or more documents within its group in the search response. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `groupField` string — The single field name that must be grouped on for this rule to be applied. - InGroupBuryListRuleSummary — Buries one or more documents within its group in the search response. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `groupField` string — The single field name that must be grouped on for this rule to be applied. - InGroupPinRuleSummary — Like `InGroupBoostListRule`, but pins a document within a group to a specific position. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `pinnedValues` PinnedValueSummary[] — A list of one or more documents to boost and pin to specific positions in the results (position 1 is the first position, 2 is the second, and so on). - … - `groupField` string — The single field name that must be grouped on for this rule to be applied. - `groupValue` string — A single group value in which the pin rule will apply to the documents. - JsonBlobRuleSummary — Returns an arbitrary JSON blob alongside the response. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `blobType` string — Indicates what kind of data this blob contains. This only has an effect if your frontend has been developed to utilize this field. You will need to know what the possible values are and what effect they have on your frontend. - `jsonBlob` string — Arbitrary JSON blob. - PinRuleSummary — Details about the pin rule. Boosts documents and then pins the matching values to absolute positions in the result set. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `pinnedValues` PinnedValueSummary[] — A list of one or more documents to boost and pin to specific positions in the results (position 1 is the first position, 2 is the second, and so on). - … - `useQec` boolean — Set to `true` to use query elevation to force-elevate documents to the top. Query elevation only supports elevation through the `id` field. Failure to configure query elevation correctly while having this box checked will cause this rule to stop working. - RedirectRuleSummary — Returns a URL for the redirect when this rule is triggered. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `url` string — Path or URL to redirect the response to. - ResponseValueRuleSummary — Common properties shared by all rule summary types. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - SetJSONFacetsRuleSummary — Details about the set JSON facets rule. Configure JSON facet API parameters for the current query. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `fieldFacets` FieldFacetConfigSummary[] — Field facet configurations. - … - `rangeFacets` RangeFacetConfigSummary[] — Range facet configurations. - … - SetParamsRuleSummary — Modify the parameters of the current request. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `params` ParamAndValueSummary[] — Modifications to make to the request parameters. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - `version` string, date-time — Current latest version of this content (timestamp taken when this content was last changed). This is not guaranteed to be the same as the `lastModified` time and should not be used as the Entity Tag (ETag) version, as this tracks when this individual rule content (staging or live) was changed, regardless of whether the rule itself was changed. For example, this version wouldn't be updated when this is the staging state of the rule and the live version of this rule's content is changed. - `lastSyncedVersion` string, date-time — Version of this content that was last successfully synced. - `fusionVersion` string — Version received when the last successful sync was performed. This value comes from the underlying search engine's optimistic concurrency mechanism. - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `url` string — Banner rule URL. - `zone` string — Banner rule zone. - BlockByAttributeRuleSummary — Blocks one or more documents that match the rule criteria in the search results, where rule criteria is an attribute (for example, `Color`) and list of values to block. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - `queries` string[] — Sets of search terms that triggers this rule. Matching logic depends on the `matchSearchQueryUsing` value. - `fieldValues` FieldValueSummary[] — Determines which filters (`fq` parameters), when specified, will trigger this rule (for example when a query has an `fq` parameter with a value of `category:Shirts`). - `name` string, required - `value` string, required - `queryProfiles` string[] — Query profile IDs for which this rule can trigger. - `effectiveStart` string, date-time — Together with `effectiveEnd`, determines the time frame in which this rule is active. Either can be null to indicate no limit in that direction. - `effectiveEnd` string, date-time — Together with `effectiveStart`, determines the time frame in which this rule is active. Either can be null to indicate no limit in that direction. - `conflicts` union[] — Rules with conflicting/overlapping conditions. - union - BannerRuleSummary — Displays a banner in the search results when rule criteria match. - … - BlockByAttributeRuleSummary — recursive - BlockListRuleSummary — Blocks one or more documents that match the rule criteria from appearing in the search results, where rule criteria is a field (for example, `id`) and list of values to block. - … - BoostAttributesRuleSummary — Boosts by either simple format (`boostParam`/`boostQuery`) or structured format (`block_groups_list`). When `block_groups_list` is present, it takes precedence over `boostParam`/`boostQuery`. - … - BoostListRuleSummary — Boosts one or more documents that match the rule criteria in the search results where rule criteria is a field (for example, `id`) and list of values to boost. - … - BuryAttributesRuleSummary — Buries documents by either `bq` or by boosting documents that match a user-supplied query. - … - BuryListRuleSummary — Downweights one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, `id`) and list of values to bury. - … - FilterListRuleSummary — Filters one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, `id`) and list of values to boost. - … - InGroupBoostListRuleSummary — Boosts one or more documents within its group in the search response. - … - InGroupBuryListRuleSummary — Buries one or more documents within its group in the search response. - … - InGroupPinRuleSummary — Like `InGroupBoostListRule`, but pins a document within a group to a specific position. - … - JsonBlobRuleSummary — Returns an arbitrary JSON blob alongside the response. - … - PinRuleSummary — Details about the pin rule. Boosts documents and then pins the matching values to absolute positions in the result set. - … - RedirectRuleSummary — Returns a URL for the redirect when this rule is triggered. - … - ResponseValueRuleSummary — Common properties shared by all rule summary types. - … - SetJSONFacetsRuleSummary — Details about the set JSON facets rule. Configure JSON facet API parameters for the current query. - … - SetParamsRuleSummary — Modify the parameters of the current request. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - `version` string, date-time — Current latest version of this content (timestamp taken when this content was last changed). This is not guaranteed to be the same as the `lastModified` time and should not be used as the Entity Tag (ETag) version, as this tracks when this individual rule content (staging or live) was changed, regardless of whether the rule itself was changed. For example, this version wouldn't be updated when this is the staging state of the rule and the live version of this rule's content is changed. - `lastSyncedVersion` string, date-time — Version of this content that was last successfully synced. - `fusionVersion` string — Version received when the last successful sync was performed. This value comes from the underlying search engine's optimistic concurrency mechanism. - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - `sourceId` string, uuid — The ID of the original rule in the source Commerce Studio instance. - `sourceEmInstanceId` string, uuid — The ID of the source Commerce Studio instance where the rule was migrated from. - `sourceBulkOperationId` string, uuid — The ID of the bulk operation that migrated this rule from the source Commerce Studio instance. - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - `key` string, required - `value` string, required - `segments` SegmentSummary[] — The segments that this rule will apply to. - `id` string, uuid — Entity ID. - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `lastModifiedBy` string — User who last updated the entity. - `lastModified` string, date-time — Date when the entity was last updated. - `name` string — Entity name. - `value` string — Value used at query time to target this segment. Cannot be changed after creation. - `type` string — Arbitrary categorization of the segment. - `ruleCount` integer — Number of rules associated with this segment, via either the rule's staging or live content. - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - BannerRuleSummary — Displays a banner in the search results when rule criteria match. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `url` string — Banner rule URL. - `zone` string — Banner rule zone. - BlockByAttributeRuleSummary — recursive - BlockListRuleSummary — Blocks one or more documents that match the rule criteria from appearing in the search results, where rule criteria is a field (for example, `id`) and list of values to block. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `termsQuerySeparator` string — Separator delimiting the values in the terms query string, defaulting to a comma. - `termsQueryMethod` 'termsFilter' | 'booleanQuery' | 'automaton' | 'docValuesTermsFilter' — Solr query execution method for matching terms. - `termsFilter` (default): Uses BooleanQuery or TermInSetQuery based on term count. Scales well with index size, moderately with number of terms. - `booleanQuery`: Creates a BooleanQuery. Scales well with index size, poorly with many terms. - `automaton`: Creates an AutomatonQuery. Scales well with index size and moderately with number of terms. - `docValuesTermsFilter`: Requires docValues-enabled fields. Automatically chooses optimal strategy based on term count. - BoostAttributesRuleSummary — Boosts by either simple format (`boostParam`/`boostQuery`) or structured format (`block_groups_list`). When `block_groups_list` is present, it takes precedence over `boostParam`/`boostQuery`. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `boostParam` string — The boost param to use, either: bq (additive) or boost (multiplicative). Part of simple format, ignored when `blockGroupsList` is present. - `boostQuery` string — The boost query to use. Part of simple format, ignored when `blockGroupsList` is present. - `blockGroupsList` BlockGroupsChainSummary[] — A list of block group chains combined with OR logic. Each chain contains `block_groups` (conditions with AND/OR logic) and a `boost_factor`. Multiple chains are ORed together, each with its own boost factor. When present, this takes precedence over `boostParam`/`boostQuery`. - … - BoostListRuleSummary — Boosts one or more documents that match the rule criteria in the search results where rule criteria is a field (for example, `id`) and list of values to boost. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `useQec` boolean — Set to `true` to use query elevation to force-elevate documents to the top. Query elevation only supports elevation through the `id` field. Failure to configure query elevation correctly while having this box checked will cause this rule to stop working. - BuryAttributesRuleSummary — Buries documents by either `bq` or by boosting documents that match a user-supplied query. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `boostParam` string — The boost param to use, either: bq (additive) or boost (multiplicative). - `boostQuery` string — The boost query to use. Use a negative boost value to decrease the score and bury matching documents. - BuryListRuleSummary — Downweights one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, `id`) and list of values to bury. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - FilterListRuleSummary — Filters one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, `id`) and list of values to boost. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `useQec` boolean — Set to `true` to use query elevation to force-elevate documents to the top. Query elevation only supports elevation through the `id` field. Failure to configure query elevation correctly while having this box checked will cause this rule to stop working. - `termsQuerySeparator` string — Separator delimiting the values in the terms query string, defaulting to a comma. - `termsQueryMethod` 'termsFilter' | 'booleanQuery' | 'automaton' | 'docValuesTermsFilter' — Solr query execution method for matching terms. - `termsFilter` (default): Uses BooleanQuery or TermInSetQuery based on term count. Scales well with index size, moderately with number of terms. - `booleanQuery`: Creates a BooleanQuery. Scales well with index size, poorly with many terms. - `automaton`: Creates an AutomatonQuery. Scales well with index size and moderately with number of terms. - `docValuesTermsFilter`: Requires docValues-enabled fields. Automatically chooses optimal strategy based on term count. - InGroupBoostListRuleSummary — Boosts one or more documents within its group in the search response. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `groupField` string — The single field name that must be grouped on for this rule to be applied. - InGroupBuryListRuleSummary — Buries one or more documents within its group in the search response. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `groupField` string — The single field name that must be grouped on for this rule to be applied. - InGroupPinRuleSummary — Like `InGroupBoostListRule`, but pins a document within a group to a specific position. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `pinnedValues` PinnedValueSummary[] — A list of one or more documents to boost and pin to specific positions in the results (position 1 is the first position, 2 is the second, and so on). - … - `groupField` string — The single field name that must be grouped on for this rule to be applied. - `groupValue` string — A single group value in which the pin rule will apply to the documents. - JsonBlobRuleSummary — Returns an arbitrary JSON blob alongside the response. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `blobType` string — Indicates what kind of data this blob contains. This only has an effect if your frontend has been developed to utilize this field. You will need to know what the possible values are and what effect they have on your frontend. - `jsonBlob` string — Arbitrary JSON blob. - PinRuleSummary — Details about the pin rule. Boosts documents and then pins the matching values to absolute positions in the result set. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `pinnedValues` PinnedValueSummary[] — A list of one or more documents to boost and pin to specific positions in the results (position 1 is the first position, 2 is the second, and so on). - … - `useQec` boolean — Set to `true` to use query elevation to force-elevate documents to the top. Query elevation only supports elevation through the `id` field. Failure to configure query elevation correctly while having this box checked will cause this rule to stop working. - RedirectRuleSummary — Returns a URL for the redirect when this rule is triggered. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `url` string — Path or URL to redirect the response to. - ResponseValueRuleSummary — Common properties shared by all rule summary types. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - SetJSONFacetsRuleSummary — Details about the set JSON facets rule. Configure JSON facet API parameters for the current query. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `fieldFacets` FieldFacetConfigSummary[] — Field facet configurations. - … - `rangeFacets` RangeFacetConfigSummary[] — Range facet configurations. - … - SetParamsRuleSummary — Modify the parameters of the current request. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `params` ParamAndValueSummary[] — Modifications to make to the request parameters. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - `version` string, date-time — Current latest version of this content (timestamp taken when this content was last changed). This is not guaranteed to be the same as the `lastModified` time and should not be used as the Entity Tag (ETag) version, as this tracks when this individual rule content (staging or live) was changed, regardless of whether the rule itself was changed. For example, this version wouldn't be updated when this is the staging state of the rule and the live version of this rule's content is changed. - `lastSyncedVersion` string, date-time — Version of this content that was last successfully synced. - `fusionVersion` string — Version received when the last successful sync was performed. This value comes from the underlying search engine's optimistic concurrency mechanism. - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - `fieldValue` string — The field value. - `representatives` object[] — Up to 3 arbitrarily-chosen representative documents of the group. This contains the raw document contents. - `memberCount` integer — The number of documents in the group. - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - `stageOverrides` ArrayNode — Overrides for the query pipeline stages. This is simply passed through as `stageOverrides` and is not validated. Be sure to verify that the overrides are valid. - `executionModifiers` object — Modifiers for the query execution. This is simply passed through as `executionModifiers` and is not validated. Be sure to verify that the modifiers are valid. - `params` object — Query parameters to be passed in the body. - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `termsQuerySeparator` string — Separator delimiting the values in the terms query string, defaulting to a comma. - `termsQueryMethod` 'termsFilter' | 'booleanQuery' | 'automaton' | 'docValuesTermsFilter' — Solr query execution method for matching terms. - `termsFilter` (default): Uses BooleanQuery or TermInSetQuery based on term count. Scales well with index size, moderately with number of terms. - `booleanQuery`: Creates a BooleanQuery. Scales well with index size, poorly with many terms. - `automaton`: Creates an AutomatonQuery. Scales well with index size and moderately with number of terms. - `docValuesTermsFilter`: Requires docValues-enabled fields. Automatically chooses optimal strategy based on term count. - `blockGroupsList` BlockGroupsChainSummary[] — A list of block group chains combined with OR logic. Each chain contains `block_groups` (conditions with AND/OR logic) and an optional `boost_factor` (ignored for blocking). Multiple chains are ORed together. Supports `EQUAL`, `GREATER_THAN`, `LESS_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`, `BETWEEN`, `NOT_EQUAL` operators. - `boostFactor` number, double — Boost factor (default 1.0, only used for boost rules, ignored for block rules). - `blockGroups` BlockGroupSummary[] — Block groups in this chain. - `operator` 'AND' | 'OR' — How this group combines with previous groups: AND or OR. Defaults to OR. The operator for the first group is ignored. - `blocks` BlockConditionSummary[] — A list of conditions within this group, combined with AND logic. - … - BlockListRuleSummary — Blocks one or more documents that match the rule criteria from appearing in the search results, where rule criteria is a field (for example, `id`) and list of values to block. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - `queries` string[] — Sets of search terms that triggers this rule. Matching logic depends on the `matchSearchQueryUsing` value. - `fieldValues` FieldValueSummary[] — Determines which filters (`fq` parameters), when specified, will trigger this rule (for example when a query has an `fq` parameter with a value of `category:Shirts`). - `name` string, required - `value` string, required - `queryProfiles` string[] — Query profile IDs for which this rule can trigger. - `effectiveStart` string, date-time — Together with `effectiveEnd`, determines the time frame in which this rule is active. Either can be null to indicate no limit in that direction. - `effectiveEnd` string, date-time — Together with `effectiveStart`, determines the time frame in which this rule is active. Either can be null to indicate no limit in that direction. - `conflicts` union[] — Rules with conflicting/overlapping conditions. - union - BannerRuleSummary — Displays a banner in the search results when rule criteria match. - … - BlockByAttributeRuleSummary — Blocks one or more documents that match the rule criteria in the search results, where rule criteria is an attribute (for example, `Color`) and list of values to block. - … - BlockListRuleSummary — recursive - BoostAttributesRuleSummary — Boosts by either simple format (`boostParam`/`boostQuery`) or structured format (`block_groups_list`). When `block_groups_list` is present, it takes precedence over `boostParam`/`boostQuery`. - … - BoostListRuleSummary — Boosts one or more documents that match the rule criteria in the search results where rule criteria is a field (for example, `id`) and list of values to boost. - … - BuryAttributesRuleSummary — Buries documents by either `bq` or by boosting documents that match a user-supplied query. - … - BuryListRuleSummary — Downweights one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, `id`) and list of values to bury. - … - FilterListRuleSummary — Filters one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, `id`) and list of values to boost. - … - InGroupBoostListRuleSummary — Boosts one or more documents within its group in the search response. - … - InGroupBuryListRuleSummary — Buries one or more documents within its group in the search response. - … - InGroupPinRuleSummary — Like `InGroupBoostListRule`, but pins a document within a group to a specific position. - … - JsonBlobRuleSummary — Returns an arbitrary JSON blob alongside the response. - … - PinRuleSummary — Details about the pin rule. Boosts documents and then pins the matching values to absolute positions in the result set. - … - RedirectRuleSummary — Returns a URL for the redirect when this rule is triggered. - … - ResponseValueRuleSummary — Common properties shared by all rule summary types. - … - SetJSONFacetsRuleSummary — Details about the set JSON facets rule. Configure JSON facet API parameters for the current query. - … - SetParamsRuleSummary — Modify the parameters of the current request. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - `version` string, date-time — Current latest version of this content (timestamp taken when this content was last changed). This is not guaranteed to be the same as the `lastModified` time and should not be used as the Entity Tag (ETag) version, as this tracks when this individual rule content (staging or live) was changed, regardless of whether the rule itself was changed. For example, this version wouldn't be updated when this is the staging state of the rule and the live version of this rule's content is changed. - `lastSyncedVersion` string, date-time — Version of this content that was last successfully synced. - `fusionVersion` string — Version received when the last successful sync was performed. This value comes from the underlying search engine's optimistic concurrency mechanism. - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - `sourceId` string, uuid — The ID of the original rule in the source Commerce Studio instance. - `sourceEmInstanceId` string, uuid — The ID of the source Commerce Studio instance where the rule was migrated from. - `sourceBulkOperationId` string, uuid — The ID of the bulk operation that migrated this rule from the source Commerce Studio instance. - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - `key` string, required - `value` string, required - `segments` SegmentSummary[] — The segments that this rule will apply to. - `id` string, uuid — Entity ID. - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `lastModifiedBy` string — User who last updated the entity. - `lastModified` string, date-time — Date when the entity was last updated. - `name` string — Entity name. - `value` string — Value used at query time to target this segment. Cannot be changed after creation. - `type` string — Arbitrary categorization of the segment. - `ruleCount` integer — Number of rules associated with this segment, via either the rule's staging or live content. - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - BannerRuleSummary — Displays a banner in the search results when rule criteria match. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `url` string — Banner rule URL. - `zone` string — Banner rule zone. - BlockByAttributeRuleSummary — Blocks one or more documents that match the rule criteria in the search results, where rule criteria is an attribute (for example, `Color`) and list of values to block. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `termsQuerySeparator` string — Separator delimiting the values in the terms query string, defaulting to a comma. - `termsQueryMethod` 'termsFilter' | 'booleanQuery' | 'automaton' | 'docValuesTermsFilter' — Solr query execution method for matching terms. - `termsFilter` (default): Uses BooleanQuery or TermInSetQuery based on term count. Scales well with index size, moderately with number of terms. - `booleanQuery`: Creates a BooleanQuery. Scales well with index size, poorly with many terms. - `automaton`: Creates an AutomatonQuery. Scales well with index size and moderately with number of terms. - `docValuesTermsFilter`: Requires docValues-enabled fields. Automatically chooses optimal strategy based on term count. - `blockGroupsList` BlockGroupsChainSummary[] — A list of block group chains combined with OR logic. Each chain contains `block_groups` (conditions with AND/OR logic) and an optional `boost_factor` (ignored for blocking). Multiple chains are ORed together. Supports `EQUAL`, `GREATER_THAN`, `LESS_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`, `BETWEEN`, `NOT_EQUAL` operators. - … - BlockListRuleSummary — recursive - BoostAttributesRuleSummary — Boosts by either simple format (`boostParam`/`boostQuery`) or structured format (`block_groups_list`). When `block_groups_list` is present, it takes precedence over `boostParam`/`boostQuery`. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `boostParam` string — The boost param to use, either: bq (additive) or boost (multiplicative). Part of simple format, ignored when `blockGroupsList` is present. - `boostQuery` string — The boost query to use. Part of simple format, ignored when `blockGroupsList` is present. - `blockGroupsList` BlockGroupsChainSummary[] — A list of block group chains combined with OR logic. Each chain contains `block_groups` (conditions with AND/OR logic) and a `boost_factor`. Multiple chains are ORed together, each with its own boost factor. When present, this takes precedence over `boostParam`/`boostQuery`. - … - BoostListRuleSummary — Boosts one or more documents that match the rule criteria in the search results where rule criteria is a field (for example, `id`) and list of values to boost. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `useQec` boolean — Set to `true` to use query elevation to force-elevate documents to the top. Query elevation only supports elevation through the `id` field. Failure to configure query elevation correctly while having this box checked will cause this rule to stop working. - BuryAttributesRuleSummary — Buries documents by either `bq` or by boosting documents that match a user-supplied query. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `boostParam` string — The boost param to use, either: bq (additive) or boost (multiplicative). - `boostQuery` string — The boost query to use. Use a negative boost value to decrease the score and bury matching documents. - BuryListRuleSummary — Downweights one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, `id`) and list of values to bury. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - FilterListRuleSummary — Filters one or more documents that match the rule criteria in the search results, where rule criteria is a field (for example, `id`) and list of values to boost. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `useQec` boolean — Set to `true` to use query elevation to force-elevate documents to the top. Query elevation only supports elevation through the `id` field. Failure to configure query elevation correctly while having this box checked will cause this rule to stop working. - `termsQuerySeparator` string — Separator delimiting the values in the terms query string, defaulting to a comma. - `termsQueryMethod` 'termsFilter' | 'booleanQuery' | 'automaton' | 'docValuesTermsFilter' — Solr query execution method for matching terms. - `termsFilter` (default): Uses BooleanQuery or TermInSetQuery based on term count. Scales well with index size, moderately with number of terms. - `booleanQuery`: Creates a BooleanQuery. Scales well with index size, poorly with many terms. - `automaton`: Creates an AutomatonQuery. Scales well with index size and moderately with number of terms. - `docValuesTermsFilter`: Requires docValues-enabled fields. Automatically chooses optimal strategy based on term count. - InGroupBoostListRuleSummary — Boosts one or more documents within its group in the search response. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - `conditions` ConditionsSummary — Conditions for the rule. - … - `conflicts` union[] — Rules with conflicting/overlapping conditions. - … - `createdBy` string — User who created the entity. - `creationDate` string, date-time — Date when the entity was created. - `deleted` boolean — Mark the rule as deleted without fully removing it from the system (if this is true or `markedForDeletion` is true). Unlike `markedForDeletion`, this is a writeable field. - `description` string — A rule description. - `externalId` string — An optional ID set by external users of the API at creation time. Cannot be changed after creation. - `groups` string[] — A method of rule organization. Rules can be part of multiple rule groups. - `hasConflicts` boolean — It should be true when there is any conflict this rule has with other rules in this Commerce Studio instance. - `id` string, uuid — Entity ID. - `lastModified` string, date-time — Date when the entity was last updated. - `lastModifiedBy` string — User who last updated the entity. - `liveFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `markedForDeletion` boolean — This is `true` if this rule is marked for deletion (`deleted` is `true`) but has not yet been fully removed from the system. This is only `true` in rare cases, and usually the system automatically resolves it. If not, you can use this key for troubleshooting. It is set internally by the system and is read-only. Rules in this state (`true`) do not appear in the listing endpoints (other than `GET` by ID) unless explicitly requested to be included. - `matchSearchQueryUsing` 'KEYWORDS' | 'TEXT' | 'PHRASE' | 'STARTS_WITH' | 'ENDS_WITH' — Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. - `migratedId` string — If this was originally migrated from another system, this field shows the ID of the original rule. - `migration` MigrationSummary — Rule migration tracking information for rules that have been migrated from one Commerce Studio instance to another. - … - `name` string — Entity name. - `pendingBulkOperation` boolean — Whether this rule is currently pending in a bulk operation (such as being published, unpublished, or deleted). This is used to indicate that the rule should not be modified until the operation is complete. Once the rule reaches a terminal status in the operation, this will be set to `false`. - `precedence` integer — Specifies the rule's precedence when multiple rules could apply to the same query. Higher values indicate higher precedence: the rule with the highest precedence is applied last and takes final effect. For example, a rule with precedence 3 will override a rule with precedence 2. If two rules have the same precedence, the more recently created rule takes precedence. - `publishState` 'DRAFT' | 'PUBLISHED' | 'PUBLISHED_WITH_DRAFT_EDITS' — The publish state of the rule: `DRAFT` (unpublished), `PUBLISHED` (published with no staged changes), or `PUBLISHED_WITH_DRAFT_EDITS` (published but with pending changes in staging). - `published` boolean — Whether the rule is staged or published. - `responseValues` KeyValueSummary[] — A list of key-value pairs representing response values. - … - `segments` SegmentSummary[] — The segments that this rule will apply to. - … - `stagingContent` union — A version of the rule that should be applied only to the staging view of Commerce Studio. This allows draft changes to be previewed prior to publishing. Changes made to this content are not visible in the live environment. - … - `stagingFusionSyncStatus` FusionSyncStatusSummary — Status of this rule's (staging or live contents) synchronization. - … - `tags` string[] — A set of short, descriptive labels for categorization or quick reference. - `type` 'BANNER', required — Rule type. Determines which schema applies. - `targetedDocumentGroups` TargetedDocumentGroupSummary[] — The documents that the rule targets. - … - `targetedDocumentsErrorMessage` string — The error message if there was an error retrieving the targeted documents. - `targetedDocumentsQueryUrl` string — The URL that was used to query for the targeted documents. - `targetedDocumentsFormParams` object — The form parameters that were used to query for the targeted documents. - `targetedDocumentsBody` FusionPreviewQueryRequest — The body of the request that was sent to the preview endpoint to retrieve the targeted documents. - … - `fieldName` string — The name of the field to which the rule applies. - `fieldValues` string[] — The values for the specified `fieldName`. Behavior depends on the rule type. For example, a boost rule would use these values to boost documents with matching field values. - `groupField` string — The single field name that must be grouped on for this rule to be applied. - InGroupBuryListRuleSummary — Buries one or more documents within its group in the search response. - `additionalProperties` object — Optional additional properties. - `conditionType` 'SEARCH' | 'CATEGORY' — Commerce Studio Rule condition type to distinguish between rules created for search versus rules created for category-based merchandising. Ignored within `stagingContent`. - … truncated; see the full OpenAPI document linked below ## Other responses - `400` — Bad request (for example, invalid filter combination) --- [API](https://skmtc.dev/lucidworks/apis/rules-rewrites-api.md) · [All operations](https://skmtc.dev/lucidworks/apis/rules-rewrites-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lucidworks/rules-rewrites-api/revisions/f2d3747848e8/schema)