afv-library/skills/platform-metadata-api-context-get/data/metadata_api/IndustriesLoyaltySettings.json

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "IndustriesLoyaltySettings - Metadata API",
  "description": "Represents the settings to enable capabilities of Loyalty Management.",
  "file_information": ".settings",
  "directory_location": "settings",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "enableAutomaticMemberTierAssessmentSelection": {
      "type": "boolean",
      "description": "Indicates whether the capability that automatically selects members as eligible for tier assessment when members’ qualifying points balance changes is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 58.0 or later."
    },
    "enableAutomaticVoucherCodeGeneration": {
      "type": "boolean",
      "description": "Indicates whether the capability to automatically generate voucher codes is enabled (true) or not (false). This field is available in API version 57.0 and later."
    },
    "enableConfigureClubs": {
      "type": "boolean",
      "description": "Indicates whether the capability to create and manage clubs is enabled (true) or not (false). The default value is false. This field is available in API version 64.0 or later."
    },
    "enableFixedTypeNQPAggregation": {
      "type": "boolean",
      "description": "Indicates whether the capability to aggregate and expire fixed type non-qualifying points in batches is enabled (true) or disabled (false) for your org. The default value is true. This field is available in API version 54.0 or later."
    },
    "enableLoyaltyApiAccessForExternalSiteUsers": {
      "type": "boolean",
      "description": "Indicates whether the capability that allows customers to join and leave loyalty programs and allows members to join and opt out of promotions from Experience Cloud sites is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 58.0 or later."
    },
    "enableLoyaltyGenerativeAi": {
      "type": "boolean",
      "description": "Indicates whether the Einstein AI capabilities of Loyalty Management are enabled (true) or not (false). The default value is false. This field is available in API version 62.0 or later."
    },
    "enableLoyaltyRedeemedPointsExpirationInfoPref": {
      "type": "boolean",
      "description": "Indicates whether the capability that automatically calculates and adds the expiration date of points credited back to members for canceled redemptions is enabled (true) or disabled (false) for your org. The default value is true. This field is available in API version 55.0 or later."
    },
    "enableLoyaltyRulesVerifyCdpMemberSegment": {
      "type": "boolean",
      "description": "Indicates whether the capability that allows: Loyalty program process rules to process transaction journals only when the loyalty program member is part of a Data Cloud segment associated with the rule's promotion is enabled (true) or disabled (false) for your org. The Promotion Eligibility component on Loyalty Program Member record page to categorize promotions based on whether the member belongs to the promotion’s campaign or Data Cloud segment is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 55.0 or later."
    },
    "enableLoyaltyServiceExcellence": {
      "type": "boolean",
      "description": "Indicates whether Service Console for Loyalty Management is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 57.0 or later."
    },
    "enableNegativePointBalance": {
      "type": "boolean",
      "description": "Indicates whether the capability that lets loyalty program members to hold negative point balances for non-qualifying currencies is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 61.0 or later."
    },
    "enableNonQualifyingPointsConsolidation": {
      "type": "boolean",
      "description": "Indicates whether the capability to aggregate and expire fixed type non-qualifying points in real time is enabled (true) or disabled (false) for your org. The default value is true. This field is available in API version 58.0 or later."
    },
    "enablePointsLifecycleTracking": {
      "type": "boolean",
      "description": "Indicates whether the capability that allows the company to trace how members redeem their accrued fixed-model non-qualifying points is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 62.0 or later."
    },
    "enableProcessTraceableTrxnAsync": {
      "type": "boolean",
      "description": "Indicates whether the capability to process traceable transactions asynchronously is enabled (true) or disabled (false) for your org. The default value is false. This field is available in API version 67.0 or later."
    },
    "enablePromSetupProcRuleStatusInheritDplymt": {
      "type": "boolean",
      "description": "Indicates whether the capability, which allows Promotion Setup processes and rules to be deployed to target orgs in the same status as the source orgs when using the LoyaltyProgramSetup metadata type, is enabled (true) or disabled (false). The default value is false. This field is available in API version 62.0 or later."
    },
    "enableQPRealTimePointBalance": {
      "type": "boolean",
      "description": "Indicates whether the real time qualifying points balance update capability is enabled (true) or disabled (false) for your org. The default value is true. This field is available in API version 55.0 or later."
    },
    "enableNQPRealTimePointBalance": {
      "type": "boolean",
      "description": "Indicates whether the capability to update the non-qualifying point balance of members in real time is enabled (true) or disabled (false) for your org. The default value is true."
    },
    "enableSegmentQueryApiMultipleDataSpace": {
      "type": "boolean",
      "description": "Indicates whether the capability that allows Query API to verify the Data Cloud segments that customers are part of across multiple data spaces is enabled (true) or not (false). The default value is false. This field is available in API version 64.0 or later."
    },
    "enableSegmentQueryByDataGraph": {
      "type": "boolean",
      "description": "Indicates whether the capability, which uses Data Cloud data graphs to query for Data Cloud segments that customers are part of, is enabled (true) or disabled (false). The default value is false. This field is available in API version 62.0 or later."
    },
    "enableTransferPointsToMemberGroupsRealtime": {
      "type": "boolean",
      "description": "Indicates whether the capability that automates real-time transfer of a member's non-qualifying points to associated group is enabled (true) or not (false). The default value is false. This field is available in API version 64.0 or later."
    },
    "enableUsePromPtyUsageForEngmtTrail": {
      "type": "boolean",
      "description": "Indicates whether the capability that uses Promotion Party Usage records to store attributes for Engagement Trail promotions is enabled (true) or not (false). The default value is true. This field is available in API version 64.0 or later."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"IndustriesLoyaltySettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"enableAutomaticMemberTierAssessmentSelection\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableAutomaticVoucherCodeGeneration\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableConfigureClubs\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableFixedTypeNQPAggregation\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableLoyaltyActivityNQPTrace\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableLoyaltyApiAccessForExternalSiteUsers\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableLoyaltyGenerativeAi\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableLoyaltyRedeemedPointsExpirationInfoPref\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableLoyaltyRulesVerifyCdpMemberSegment\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableLoyaltyServiceExcellence\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableNQPRealTimePointBalance\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableNegativePointBalance\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableNonQualifyingPointsConsolidation\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enablePointsLifecycleTracking\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableProcessTraceableTrxnAsync\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enablePromSetupProcRuleStatusInheritDplymt\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableQPRealTimePointBalance\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableSegmentQueryApiMultipleDataSpace\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableSegmentQueryByDataGraph\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableTransferPointsToMemberGroupsRealtime\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableUsePromPtyUsageForEngmtTrail\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of a IndustriesLoyaltySettings component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<IndustriesLoyaltySettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <enableNQPRealTimePointBalance>true</enableNQPRealTimePointBalance>\n    <enableFixedTypeNQPAggregation>true</enableFixedTypeNQPAggregation>\n    <enableQPRealTimePointBalance>true</enableQPRealTimePointBalance>\n    <enableLoyaltyRulesVerifyCdpMemberSegment>false</enableLoyaltyRulesVerifyCdpMemberSegment>\n    <enableLoyaltyRedeemedPointsExpirationInfoPref>true</enableLoyaltyRedeemedPointsExpirationInfoPref>\n    <enableLoyaltyServiceExcellence>true</enableLoyaltyServiceExcellence>\n    <enableAutomaticVoucherCodeGeneration>true</enableAutomaticVoucherCodeGeneration>\n    <enableLoyaltyApiAccessForExternalSiteUsers>false</enableLoyaltyApiAccessForExternalSiteUsers>\n    <enableAutomaticMemberTierAssessmentSelection>false</enableAutomaticMemberTierAssessmentSelection>\n    <enableNonQualifyingPointsConsolidation>false</enableNonQualifyingPointsConsolidation>\n    <enablePointsLifecycleTracking>false</enablePointsLifecycleTracking>\n    <enableProcessTraceableTrxnAsync>false</enableProcessTraceableTrxnAsync>\n    <enableNegativePointBalance>false</enableNegativePointBalance>\n    <enableSegmentQueryByDataGraph>false</enableSegmentQueryByDataGraph>\n    <enablePromSetupProcRuleStatusInheritDplymt>false</enablePromSetupProcRuleStatusInheritDplymt>\n    <enableLoyaltyGenerativeAi>false</enableLoyaltyGenerativeAi>\n    <enableTransferPointsToMemberGroupsRealtime>false</enableTransferPointsToMemberGroupsRealtime>\n    <enableUsePromPtyUsageForEngmtTrail>false</enableUsePromPtyUsageForEngmtTrail>\n    <enableSegmentQueryApiMultipleDataSpace>true</enableSegmentQueryApiMultipleDataSpace>\n    <enableConfigureClubs>true</enableConfigureClubs>\n</IndustriesLoyaltySettings>"
    }
  ]
}