{"id":"5d63e2d1-8aa7-465f-b623-9259a9c6d984","createdDate":"2024-09-19T12:32:05.438Z","updatedDate":"2024-09-19T12:32:05.438Z","resourceId":"77467507-9571-424d-9572-dcf2488c5113","api":{"schema":{"object":{"displayName":"Loyalty Earning Rule Object","description":"A loyalty earning rule defines how customers earn points in a loyalty program.\nYou can create rules for different activities, such as making purchases.","slug":"loyalty-earning-rule-object","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","legacyExamples":[{"title":"LoyaltyEarningRule","content":"{\n \"id\": \"61f971c4-b33b-4f39-8ebe-2677bce55789\",\n \"source_app_id\": \"139ef4fa-c108-8f9a-c7be-d5f492a2c939\",\n \"trigger_app_id\": \"eb377299-86b4-4a86-a1b5-774a2d1d374b\",\n \"trigger_activity_type\": \"wix_members-uou_signs_up\",\n \"title\": \"Sign up to the site\",\n \"status\": \"ACTIVE\",\n \"revision\": null,\n \"created_date\": \"2024-08-01T11:51:41.431Z\",\n \"updated_date\": \"2024-09-16T12:03:00.434Z\",\n \"metadata\": {\n \"can_be_deleted\": false\n },\n \"fixed_amount\": {\n \"points\": 50,\n \"configs\": [\n {\n \"tier_id\": null,\n \"points\": 50\n }\n ]\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"methods":[{"summary":"Create Loyalty Earning Rule","description":"Creates a non-automated earning rule.\n\n>**Note**: You can only create non-automated earning rules from a supported list.\nFor the supported list of services, see the [introduction](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/introduction#non-automated-earning-rules).","operationId":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules.CreateLoyaltyEarningRule","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.CreateLoyaltyEarningRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-earning-rules","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-earning-rules","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateLoyaltyEarningRuleRequest","description":"","properties":{"earningRule":{"description":"Earning rule to create.","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","summary":"earningRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["earningRule","earningRule.sourceAppId","earningRule.triggerAppId","earningRule.triggerActivityType","earningRule.title","earningRule.type","earningRule.status"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_EARNING_RULES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.CreateLoyaltyEarningRuleRequest","responseMessage":"com.wixpress.loyalty.earningrule.CreateLoyaltyEarningRuleResponse"},"legacyExamples":[{"name":"CreateLoyaltyEarningRule","type":"METHOD","content":{"title":"Create earning rule","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/earning-rules' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"earningRule\": {\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"status\": \"ACTIVE\",\n \"conversionRate\": {\n \"configs\": [\n {\n \"points\": 20,\n \"moneyAmount\": 1\n }\n ]\n }\n }\n }'","response":"{\n \"earningRule\": {\n \"id\": \"b690f925-8527-4d5e-b358-4b0adcb275b5\",\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"conversionRate\": {\n \"moneyAmount\": 1,\n \"points\": 20,\n \"configs\": [\n {\n \"moneyAmount\": 1,\n \"points\": 20\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T12:06:39.294Z\",\n \"updatedDate\": \"2024-09-16T12:06:39.294Z\",\n \"metadata\": {\n \"canBeDeleted\": true\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/earning-rules","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_EARNING_RULES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.CreateLoyaltyEarningRuleRequest","responseMessage":"com.wixpress.loyalty.earningrule.CreateLoyaltyEarningRuleResponse"},"legacyExamples":[{"name":"CreateLoyaltyEarningRule","type":"METHOD","content":{"title":"Create earning rule","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/earning-rules' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"earningRule\": {\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"status\": \"ACTIVE\",\n \"conversionRate\": {\n \"configs\": [\n {\n \"points\": 20,\n \"moneyAmount\": 1\n }\n ]\n }\n }\n }'","response":"{\n \"earningRule\": {\n \"id\": \"b690f925-8527-4d5e-b358-4b0adcb275b5\",\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"conversionRate\": {\n \"moneyAmount\": 1,\n \"points\": 20,\n \"configs\": [\n {\n \"moneyAmount\": 1,\n \"points\": 20\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T12:06:39.294Z\",\n \"updatedDate\": \"2024-09-16T12:06:39.294Z\",\n \"metadata\": {\n \"canBeDeleted\": true\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Create Loyalty Earning Rule","slugifiedName":"create-loyalty-earning-rule"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Bulk Create Loyalty Earning Rules","description":"Creates multiple non-automated earning rules.\n\n>**Note**: You can only create non-automated earning rules from a supported list.\nFor the supported list of services, see the [introduction](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/introduction#non-automated-earning-rules).","operationId":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules.BulkCreateLoyaltyEarningRules","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.BulkCreateLoyaltyEarningRulesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-earning-rules","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-earning-rules","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkCreateLoyaltyEarningRulesRequest","description":"","properties":{"earningRules":{"description":"Earning rules to create.","minItems":1,"maxItems":100,"title":"earningRules","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["earningRules","earningRules.sourceAppId","earningRules.triggerAppId","earningRules.triggerActivityType","earningRules.title","earningRules.type","earningRules.status"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_EARNING_RULES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.BulkCreateLoyaltyEarningRulesRequest","responseMessage":"com.wixpress.loyalty.earningrule.BulkCreateLoyaltyEarningRulesResponse"},"legacyExamples":[{"name":"BulkCreateLoyaltyEarningRules","type":"METHOD","content":{"title":"Bulk create earning rules","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/bulk/earning-rules/create' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"earningRules\": [\n {\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"status\": \"ACTIVE\",\n \"conversionRate\": {\n \"configs\": [\n {\n \"points\": 20,\n \"moneyAmount\": 1\n }\n ]\n }\n }\n ]\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"eeb9ff42-b24f-4a68-8491-21507508f3f5\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"eeb9ff42-b24f-4a68-8491-21507508f3f5\",\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"conversionRate\": {\n \"moneyAmount\": 1,\n \"points\": 20,\n \"configs\": [\n {\n \"moneyAmount\": 1,\n \"points\": 20\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T12:12:16.833Z\",\n \"updatedDate\": \"2024-09-16T12:12:16.833Z\",\n \"metadata\": {\n \"canBeDeleted\": true\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/bulk/earning-rules/create","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_EARNING_RULES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.BulkCreateLoyaltyEarningRulesRequest","responseMessage":"com.wixpress.loyalty.earningrule.BulkCreateLoyaltyEarningRulesResponse"},"legacyExamples":[{"name":"BulkCreateLoyaltyEarningRules","type":"METHOD","content":{"title":"Bulk create earning rules","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/bulk/earning-rules/create' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"earningRules\": [\n {\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"status\": \"ACTIVE\",\n \"conversionRate\": {\n \"configs\": [\n {\n \"points\": 20,\n \"moneyAmount\": 1\n }\n ]\n }\n }\n ]\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"eeb9ff42-b24f-4a68-8491-21507508f3f5\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"eeb9ff42-b24f-4a68-8491-21507508f3f5\",\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"conversionRate\": {\n \"moneyAmount\": 1,\n \"points\": 20,\n \"configs\": [\n {\n \"moneyAmount\": 1,\n \"points\": 20\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T12:12:16.833Z\",\n \"updatedDate\": \"2024-09-16T12:12:16.833Z\",\n \"metadata\": {\n \"canBeDeleted\": true\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Bulk Create Loyalty Earning Rules","slugifiedName":"bulk-create-loyalty-earning-rules"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Get Loyalty Earning Rule","description":"Retrieves a specified non-automated earning rule.\n\nTo retrieve both automated and non-automated earning rules, use [List Earning Rules](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/list-earning-rules).","operationId":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules.GetLoyaltyEarningRule","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the earning rule to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.GetLoyaltyEarningRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-earning-rules","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-earning-rules","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_EARNING_RULES"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.GetLoyaltyEarningRuleRequest","responseMessage":"com.wixpress.loyalty.earningrule.GetLoyaltyEarningRuleResponse"},"legacyExamples":[{"name":"GetLoyaltyEarningRule","type":"METHOD","content":{"title":"Get earning rule","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/earning-rules/eeb9ff42-b24f-4a68-8491-21507508f3f5' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{\n \"earningRule\": {\n \"id\": \"eeb9ff42-b24f-4a68-8491-21507508f3f5\",\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"conversionRate\": {\n \"moneyAmount\": 1,\n \"points\": 20,\n \"configs\": [\n {\n \"moneyAmount\": 1,\n \"points\": 20\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T12:12:16.833Z\",\n \"updatedDate\": \"2024-09-16T12:12:16.833Z\",\n \"metadata\": {\n \"canBeDeleted\": true\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/earning-rules/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_EARNING_RULES"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.GetLoyaltyEarningRuleRequest","responseMessage":"com.wixpress.loyalty.earningrule.GetLoyaltyEarningRuleResponse"},"legacyExamples":[{"name":"GetLoyaltyEarningRule","type":"METHOD","content":{"title":"Get earning rule","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/earning-rules/eeb9ff42-b24f-4a68-8491-21507508f3f5' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{\n \"earningRule\": {\n \"id\": \"eeb9ff42-b24f-4a68-8491-21507508f3f5\",\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"conversionRate\": {\n \"moneyAmount\": 1,\n \"points\": 20,\n \"configs\": [\n {\n \"moneyAmount\": 1,\n \"points\": 20\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T12:12:16.833Z\",\n \"updatedDate\": \"2024-09-16T12:12:16.833Z\",\n \"metadata\": {\n \"canBeDeleted\": true\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Loyalty Earning Rule","slugifiedName":"get-loyalty-earning-rule"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"isAdminMethod":false},{"summary":"Delete Loyalty Earning Rule","description":"Deletes a non-automated earning rule.\n\nTo delete an automated earning rule, use\n[Delete Automation Earning Rule](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/delete-automation-earning-rule).\n\nTo update an earning rule's status instead of deleting it, use\n[Update Loyalty Earning Rule](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/update-loyalty-earning-rule).","operationId":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules.DeleteLoyaltyEarningRule","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the earning rule to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"revision","in":"query","description":"Revision of the earning rule. Incremented by 1 each time the earning rule is updated.\nPass the latest revision when updating to prevent conflicting changes.","required":false,"schema":{"description":"Revision of the earning rule. Incremented by 1 each time the earning rule is updated.\nPass the latest revision when updating to prevent conflicting changes.","title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.DeleteLoyaltyEarningRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-earning-rules","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-earning-rules","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_EARNING_RULES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.DeleteLoyaltyEarningRuleRequest","responseMessage":"com.wixpress.loyalty.earningrule.DeleteLoyaltyEarningRuleResponse"},"legacyExamples":[{"name":"DeleteLoyaltyEarningRule","type":"METHOD","content":{"title":"Delete earning rule","request":"curl -X DELETE \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/earning-rules/eeb9ff42-b24f-4a68-8491-21507508f3f5?revision=2' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"delete","path":"/v1/earning-rules/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_EARNING_RULES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.DeleteLoyaltyEarningRuleRequest","responseMessage":"com.wixpress.loyalty.earningrule.DeleteLoyaltyEarningRuleResponse"},"legacyExamples":[{"name":"DeleteLoyaltyEarningRule","type":"METHOD","content":{"title":"Delete earning rule","request":"curl -X DELETE \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/earning-rules/eeb9ff42-b24f-4a68-8491-21507508f3f5?revision=2' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Delete Loyalty Earning Rule","slugifiedName":"delete-loyalty-earning-rule"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Delete Automation Earning Rule","description":"Deletes a custom automated earning rule.\nPre-installed automated rules can only be paused, not deleted.\n\nTo update an earning rule's status instead of deleting it, use\n[Update Loyalty Earning Rule](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/update-loyalty-earning-rule).\n\nTo delete a non-automated earning rule, use\n[Delete Loyalty Earning Rule](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/delete-loyalty-earning-rule).","operationId":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules.DeleteAutomationEarningRule","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the earning rule to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.DeleteAutomationEarningRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-earning-rules","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-earning-rules","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_EARNING_RULES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.DeleteAutomationEarningRuleRequest","responseMessage":"com.wixpress.loyalty.earningrule.DeleteAutomationEarningRuleResponse"},"legacyExamples":[{"name":"DeleteAutomationEarningRule","type":"METHOD","content":{"title":"Delete automation earning rule","request":"curl -X DELETE \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/automation-earning-rules/61f971c4-b33b-4f39-8ebe-2677bce55789' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"delete","path":"/v1/automation-earning-rules/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_EARNING_RULES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.DeleteAutomationEarningRuleRequest","responseMessage":"com.wixpress.loyalty.earningrule.DeleteAutomationEarningRuleResponse"},"legacyExamples":[{"name":"DeleteAutomationEarningRule","type":"METHOD","content":{"title":"Delete automation earning rule","request":"curl -X DELETE \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/automation-earning-rules/61f971c4-b33b-4f39-8ebe-2677bce55789' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Delete Automation Earning Rule","slugifiedName":"delete-automation-earning-rule"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Update Loyalty Earning Rule","description":"Updates an earning rule.\n\nSupports partial updates.\n\nRevision number, which increments by 1 each time the earning rule is updated. To prevent conflicting changes,\nthe current revision must be passed when updating the earning rule.","operationId":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules.UpdateLoyaltyEarningRule","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"earningRule.id","description":"Loyalty earning rule ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.UpdateLoyaltyEarningRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-earning-rules","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-earning-rules","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateLoyaltyEarningRuleRequest","description":"","properties":{"earningRule":{"description":"Earning rule to update.","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","summary":"earningRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["earningRule","earningRule.id"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_EARNING_RULES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.UpdateLoyaltyEarningRuleRequest","responseMessage":"com.wixpress.loyalty.earningrule.UpdateLoyaltyEarningRuleResponse"},"legacyExamples":[{"name":"UpdateLoyaltyEarningRule","type":"METHOD","content":{"title":"Update earning rule","request":"curl -X PUT \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/earning-rules/eeb9ff42-b24f-4a68-8491-21507508f3f5' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"earningRule\": {\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"status\": \"ACTIVE\",\n \"conversionRate\": {\n \"configs\": [\n {\n \"points\": 20,\n \"moneyAmount\": 1\n }\n ]\n },\n \"revision\": 1\n }\n }'","response":"{\n \"earningRule\": {\n \"id\": \"eeb9ff42-b24f-4a68-8491-21507508f3f5\",\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"conversionRate\": {\n \"moneyAmount\": 1,\n \"points\": 20,\n \"configs\": [\n {\n \"moneyAmount\": 1,\n \"points\": 20\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-09-16T12:12:16.833Z\",\n \"updatedDate\": \"2024-09-16T14:02:59.364Z\",\n \"metadata\": {\n \"canBeDeleted\": true\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"put","path":"/v1/earning-rules/{earningRule.id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_EARNING_RULES"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.UpdateLoyaltyEarningRuleRequest","responseMessage":"com.wixpress.loyalty.earningrule.UpdateLoyaltyEarningRuleResponse"},"legacyExamples":[{"name":"UpdateLoyaltyEarningRule","type":"METHOD","content":{"title":"Update earning rule","request":"curl -X PUT \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/earning-rules/eeb9ff42-b24f-4a68-8491-21507508f3f5' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"earningRule\": {\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"status\": \"ACTIVE\",\n \"conversionRate\": {\n \"configs\": [\n {\n \"points\": 20,\n \"moneyAmount\": 1\n }\n ]\n },\n \"revision\": 1\n }\n }'","response":"{\n \"earningRule\": {\n \"id\": \"eeb9ff42-b24f-4a68-8491-21507508f3f5\",\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"conversionRate\": {\n \"moneyAmount\": 1,\n \"points\": 20,\n \"configs\": [\n {\n \"moneyAmount\": 1,\n \"points\": 20\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-09-16T12:12:16.833Z\",\n \"updatedDate\": \"2024-09-16T14:02:59.364Z\",\n \"metadata\": {\n \"canBeDeleted\": true\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Update Loyalty Earning Rule","slugifiedName":"update-loyalty-earning-rule"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"List Earning Rules","description":"Retrieves a list of earning rules.\n\nReturns both automated and non-automated earning rules.\n\nYou can filter the results by `triggerAppId` or `triggerActivityType`.","operationId":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules.ListEarningRules","parameters":[{"name":"triggerAppId","in":"query","description":"App ID that triggers the point assignment. For example, `9a5d83fd-8570-482e-81ab-cfa88942ee60`.","required":false,"schema":{"description":"App ID that triggers the point assignment. For example, `9a5d83fd-8570-482e-81ab-cfa88942ee60`.","title":"triggerAppId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"triggerActivityType","in":"query","description":"Type of activity that triggers the point assignment. For example, `restaurants-order-is-pending`.","required":false,"schema":{"description":"Type of activity that triggers the point assignment. For example, `restaurants-order-is-pending`.","title":"triggerActivityType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.ListEarningRulesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/_api/loyalty-earning-rules","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/loyalty-earning-rules","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_EARNING_RULES"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.ListEarningRulesRequest","responseMessage":"com.wixpress.loyalty.earningrule.ListEarningRulesResponse"},"legacyExamples":[{"name":"ListEarningRules","type":"METHOD","content":{"title":"List earning rules","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/earning-rules/rules' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{\n \"earningRules\": [\n {\n \"id\": \"eeb9ff42-b24f-4a68-8491-21507508f3f5\",\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"conversionRate\": {\n \"moneyAmount\": 1,\n \"points\": 20,\n \"configs\": [\n {\n \"moneyAmount\": 1,\n \"points\": 20\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T12:12:16.833Z\",\n \"updatedDate\": \"2024-09-16T12:12:16.833Z\",\n \"metadata\": {\n \"canBeDeleted\": true\n }\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/earning-rules/rules","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.earningrule.LoyaltyEarningRules","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_EARNING_RULES"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-earning-rules","serviceArtifactId":"com.wixpress.loyalty.loyalty-earning-rules","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.earningrule.ListEarningRulesRequest","responseMessage":"com.wixpress.loyalty.earningrule.ListEarningRulesResponse"},"legacyExamples":[{"name":"ListEarningRules","type":"METHOD","content":{"title":"List earning rules","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-earning-rules/v1/earning-rules/rules' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json'","response":"{\n \"earningRules\": [\n {\n \"id\": \"eeb9ff42-b24f-4a68-8491-21507508f3f5\",\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"conversionRate\": {\n \"moneyAmount\": 1,\n \"points\": 20,\n \"configs\": [\n {\n \"moneyAmount\": 1,\n \"points\": 20\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T12:12:16.833Z\",\n \"updatedDate\": \"2024-09-16T12:12:16.833Z\",\n \"metadata\": {\n \"canBeDeleted\": true\n }\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"List Earning Rules","slugifiedName":"list-earning-rules"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"isAdminMethod":false}],"webhooks":[{"summary":"Loyalty Earning Rule Created","title":"Loyalty Earning Rule Created","description":"Triggered when an earning rule is created.","permissions":["LOYALTY.READ_EARNING_RULES"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.loyalty_earning_rule","serviceName":"","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"eventType":"wix.loyalty.v1.loyalty_earning_rule_created","legacyExamples":[{"name":"LoyaltyEarningRuleCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"79e98s2a-d8j4-4a3b-a62f-7393757bab84\",\n \"entityFqdn\": \"wix.loyalty.v1.loyalty_earning_rule\",\n \"slug\": \"created\",\n \"entityId\": \"5bf5cb44-87rt-4933-1234-1d8423636a74\",\n \"createdEvent\": {\n \"entity\": {\n \"id\": \"b690f925-8527-4d5e-b358-4b0adcb275b5\",\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"conversionRate\": {\n \"moneyAmount\": 1,\n \"points\": 20,\n \"configs\": [\n {\n \"moneyAmount\": 1,\n \"points\": 20\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T12:06:39.294Z\",\n \"updatedDate\": \"2024-09-16T12:06:39.294Z\",\n \"metadata\": {\n \"canBeDeleted\": true\n }\n }\n },\n \"eventTime\": \"2023-09-11T14:58:22.481838Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"1\"\n}\n"}],"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","contentLink":{"displayName":"Loyalty Earning Rule Created","slugifiedName":"loyalty-earning-rule-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]},{"summary":"Loyalty Earning Rule Updated","title":"Loyalty Earning Rule Updated","description":"Triggered when an earning rule is updated.","permissions":["LOYALTY.READ_EARNING_RULES"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.loyalty_earning_rule","serviceName":"","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"eventType":"wix.loyalty.v1.loyalty_earning_rule_updated","legacyExamples":[{"name":"LoyaltyEarningRuleUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"79e98s2a-d8j4-4a3b-a62f-7393757bab84\",\n \"entityFqdn\": \"wix.loyalty.v1.loyalty_earning_rule\",\n \"slug\": \"updated\",\n \"entityId\": \"5bf5cb44-87rt-4933-1234-1d8423636a74\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"id\": \"b690f925-8527-4d5e-b358-4b0adcb275b5\",\n \"sourceAppId\": \"553c79f3-5625-4f38-b14b-ef7c0d1e87df\",\n \"triggerAppId\": \"1380b703-ce81-ff05-f115-39571d94dfcd\",\n \"triggerActivityType\": \"stores/OrderPaid\",\n \"title\": \"Purchase a product\",\n \"conversionRate\": {\n \"moneyAmount\": 1,\n \"points\": 20,\n \"configs\": [\n {\n \"moneyAmount\": 1,\n \"points\": 20\n }\n ]\n },\n \"status\": \"ACTIVE\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-16T12:06:39.294Z\",\n \"updatedDate\": \"2024-09-16T12:06:39.294Z\",\n \"metadata\": {\n \"canBeDeleted\": true\n }\n }\n },\n \"eventTime\": \"2023-09-11T14:58:22.481838Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"1\"\n}\n"}],"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","contentLink":{"displayName":"Loyalty Earning Rule Updated","slugifiedName":"loyalty-earning-rule-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]},{"summary":"Loyalty Earning Rule Deleted","title":"Loyalty Earning Rule Deleted","description":"Triggered when an earning rule is deleted.","permissions":["LOYALTY.READ_EARNING_RULES"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.loyalty.v1.loyalty_earning_rule","serviceName":"","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"eventType":"wix.loyalty.v1.loyalty_earning_rule_deleted","legacyExamples":[{"name":"LoyaltyEarningRuleDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"79e98s2a-d8j4-4a3b-a62f-7393757bab84\",\n \"entityFqdn\": \"wix.loyalty.v1.loyalty_earning_rule\",\n \"slug\": \"deleted\",\n \"entityId\": \"5bf5cb44-87rt-4933-1234-1d8423636a74\",\n \"deletedEvent\": {},\n \"eventTime\": \"2023-09-11T14:58:22.481838Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"1\"\n}\n"}],"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","contentLink":{"displayName":"Loyalty Earning Rule Deleted","slugifiedName":"loyalty-earning-rule-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Earning Rules API allows you to manage earning rules for your loyalty program. Earning rules define how customers earn points through various activities, such as making purchases or registering for events.\n\nWith the Earning Rules API, you can:\n\n+ [Create loyalty earning rules](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/create-loyalty-earning-rule) to set up new rules for earning points.\n+ [List earning rules](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/list-earning-rules) to retrieve all earning rules in your loyalty program.\n+ [Bulk create loyalty earning rules](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/bulk-create-loyalty-earning-rules) to set up multiple earning rules at once.\n+ [Update loyalty earning rules](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/update-loyalty-earning-rule) to modify existing earning rules.\n+ [Delete loyalty earning rules](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/delete-loyalty-earning-rule) to remove earning rules that are no longer needed.\n+ [Delete automation earning rules](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/delete-automation-earning-rule) to remove automated earning rules.\n\nFor more information about managing loyalty programs, see the [Loyalty API](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/introduction). To learn more about earning rules, see [Managing Your Loyalty Program](fallback::https://support.wix.com/en/article/wix-loyalty-program-managing-your-loyalty-program).\n\n## Earning Rules and Points Calculation\n\nAn earning rule defines how customers receive loyalty points for specific actions they take on your site, such as making a purchase or booking an appointment. Customers accumulate these loyalty points and can later exchange them for rewards like discounts or free shipping at checkout.\n\nEarning rules use two methods to calculate loyalty points:\n\n+ **Fixed amount**: Awards a set number of points for a specific action. \n Example: A customer receives 10 points for purchasing a ticket through Wix Events.\n+ **Conversion rate**: Awards points based on a ratio of money spent to points earned. \n Example: A customer receives 2 points for every $1 spent in your online store.\n \n The formula is: `points awarded = (amount spent / moneyAmount) * points per unit`.\n \n For a $100 purchase with 2 points awarded per $1 spent: \n `points awarded = (100 / 1) * 2 = 200 points`\n\nOnce customers accumulate loyalty points, they can redeem them for various rewards during the checkout process. For example, exchanging 500 points for a 10% discount on their purchase.\n\n## Types of earning rules\n\nThe Wix Loyalty program supports two types of earning rules:\n\n+ Non-automated earning rules.\n+ Automated earning rules.\n\nBoth types allow customers to earn points for various actions, but differ in their flexibility and customization options:\n\n+ Non-automated earning rules are limited to a fixed set of supported rules (see tables below) based on installed Wix business solutions.\n+ Automated earning rules, powered by Wix Automations, allow for unlimited custom earning rule creation.\n\nWe recommend creating automated earning rules using the [Wix Automations API](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/business-management/automations/introduction) for maximum flexibility and customization options.\n\n### Automated earning rules\n\nAutomated earning rules are managed by [Wix Automations](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/business-management/automations/introduction), a system that enables custom workflows across Wix apps. These rules offer more flexibility and can be triggered by a wide range of events.\n\nThere are two subtypes of automated earning rules:\n\n+ Pre-installed rules.\n+ Custom rules.\n\n#### Pre-installed rules\n\nPre-installed rules come automatically when certain business solutions are installed. These rules can be paused but not deleted.\n\nSupported pre-installed earning rules:\n\n| Earning Rule Name | Trigger | Point award method |\n|-----------|---------------|-----------------|\n| Order a plan (Wix Pricing Plans) | `wix_pricing_plans-plan_purchased` | Fixed amount, Conversion rate |\n| Place a restaurant order (Old Wix Restaurants) | `wix_restaurants_orders-order_submitted` | Conversion rate only |\n| Place a restaurant order (New Wix Restaurants) | `restaurants-order-is-pending` | Conversion rate only |\n\n#### Custom rules\n\nCustom rules are created by site owners and don't come pre-installed. Automated earning rules not listed above fall into this category.\n\nFor example, if Wix Bookings is installed, you can create a custom automated earning rule that is triggered when a customer books a session.\n\n### Non-automated earning rules\n\nNon-automated earning rules can be created based on installed Wix business solutions. These rules are identified by their `sourceAppId`, which is the Loyalty app ID for non-automated rules.\n\nSupported non-automated earning rules:\n\n| Earning Rule Name | Trigger | Point award method |\n|-----------|---------------|-----------------|\n| Purchase a product (Wix Stores) | `stores/OrderPaid` | Fixed amount, Conversion rate |\n| Book a session (Wix Bookings) | `bookings/BookingConfirmed` | Fixed amount only |\n| Buy a ticket (Wix Events) | `events/OrderConfirmed` | Fixed amount, Conversion rate |\n| RSVP to an event (Wix Events) | `events/Rsvp` | Fixed amount only |\n\n\nFor example, if Wix Events is installed, two types of earning rules can be created:\n+ A rule that awards points when a customer buys a ticket (triggered by `events/OrderConfirmed`).\n+ A rule that awards points when a customer RSVPs to a free event (triggered by `events/Rsvp`).\n\n\nThese non-automated rules provide a way to set up basic loyalty rewards without the Wix automations setup. They are useful for implementing a straightforward points system based on common customer actions within Wix apps.\n\n## Wix Automations and Earning Rules\n\nAutomated earning rules are powered by [Wix Automations](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/business-management/automations/introduction), a system that enables custom workflows across Wix apps.\n\nWix Automations are built on two key concepts:\n\n- **Triggers**: Events that initiate automations.\n- **Actions**: Responses to triggers.\n\nTo create and manage automated earning rules, you'll use the Wix Automations API. This API allows you to define custom triggers, implement action logic, and activate automations.\n\nFor more information on working with Wix Automations, see the [Automations API Introduction](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/business-management/automations/introduction).\n\n## Terminology\n\n+ __Earning rule__: A condition that, when met, awards loyalty points to a customer. All earning rules allow customers to earn points for performing certain actions.\n+ __Non-Automated earning rule__: An earning rule set up for specific business solutions, identified by its `sourceAppId`.\n+ __Automated earning rule__: An earning rule powered by Wix Automations, which can be pre-installed or custom:\n - __Pre-installed__: An automated earning rule that comes by default with certain services, which can be paused but not deleted.\n - __Custom__: An automated earning rule created by the site owner that is not pre-installed by default. Custom rules can be deleted.\n+ __Fixed amount__: An earning rule type where a set number of points is awarded for a specific action. For example, a customer might receive 10 points for purchasing a ticket through Wix Events.\n+ __Conversion rate__: An earning rule type where points are awarded based on a ratio of money spent to points earned. The formula is: `points awarded = (amount spent / moneyAmount) * points per unit`.\n+ __Trigger app ID__: The ID of the app that initiates the point assignment. For example: Stores, Bookings, Events.\n+ __Trigger activity type__: The specific action that triggers point assignment. For example: `auth/register`, `events/OrderConfirmed`.\n+ __Source app ID__: The ID of the app managing the rule. This field indicates whether an earning rule is automated or non-automated. If the `sourceAppId` is the Loyalty app ID, it's a non-automated earning rule. If it's the Wix Automations app ID, it's an automated earning rule.\n+ __Tier__: A tier is a loyalty level that customers are assigned to based on the number of points they earn. Customers in different tiers may earn points at different rates for the same activity. For example, a higher tier member might earn more points per purchase than a lower tier member.\n+ __Status__: The current state of an earning rule (for example, `ACTIVE`, `PAUSED`)."}],"components":{"schemas":{"com.wixpress.loyalty.earningrule.LoyaltyEarningRule":{"type":"object","properties":{"id":{"description":"Loyalty earning rule ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sourceAppId":{"description":"ID of the app managing the earning rule. Can be a loyalty app ID or a Wix automations app ID.","format":"GUID","title":"sourceAppId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggerAppId":{"description":"ID of the app that triggers point assignment. Examples: Wix Stores, Wix Bookings, Wix Events.","minLength":1,"maxLength":80,"title":"triggerAppId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggerActivityType":{"description":"Type of activity that triggers point assignment. For example, `wix-restaurants/orderSubmitted` or `birthday`.","minLength":1,"maxLength":80,"title":"triggerActivityType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Name of the earning rule.","minLength":1,"maxLength":50,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Current status of the earning rule.\n\n- `UNKNOWN`: Status is unknown or not specified.\n- `ACTIVE`: Earning rule is active and can assign points.\n- `PAUSED`: Earning rule is paused and cannot assign points.","title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.StatusEnum.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, incremented by 1 each time the earning rule is updated.\nPass the latest revision when updating to prevent conflicting changes.","title":"revision","type":"integer","format":"uint64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the earning rule was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the earning rule was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Additional metadata about the earning rule.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.Metadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LoyaltyEarningRule","description":"A loyalty earning rule defines how customers earn points in a loyalty program.\nYou can create rules for different activities, such as making purchases.","oneOf":[{"description":"","summary":"type","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule.type"}]},"com.wixpress.loyalty.earningrule.LoyaltyEarningRule.type":{"type":"object","title":"type","properties":{"fixedAmount":{"description":"Fixed amount of points awarded for each qualifying activity.","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.FixedAmount","summary":"fixedAmount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"conversionRate":{"description":"Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`.","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.ConversionRate","summary":"conversionRate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"com.wixpress.loyalty.earningrule.FixedAmount":{"type":"object","properties":{"points":{"description":"Deprecated. Use `configs` instead.","title":"points","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"Deprecated. Use `configs` instead.","replacedBy":"configs","targetRemovalDate":"2022-09-01"}}},"configs":{"description":"Fixed amount configurations for each tier.","maxItems":21,"title":"configs","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.FixedAmountConfig"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FixedAmount","description":"Fixed amount type of earning rule."},"com.wixpress.loyalty.earningrule.FixedAmountConfig":{"type":"object","properties":{"tierId":{"description":"Tier ID. If empty, the [base tier](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/tiers/introduction#terminology) is used.","format":"GUID","readOnly":true,"title":"tierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"points":{"description":"Number of points to award.","title":"points","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FixedAmountConfig","description":""},"com.wixpress.loyalty.earningrule.ConversionRate":{"type":"object","properties":{"moneyAmount":{"description":"Deprecated. Use `configs` instead.","title":"moneyAmount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"Deprecated. Use `configs` instead.","replacedBy":"configs","targetRemovalDate":"2022-09-01"}}},"points":{"description":"Deprecated. Use `configs` instead.","title":"points","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"Deprecated. Use `configs` instead.","replacedBy":"configs","targetRemovalDate":"2022-09-01"}}},"configs":{"description":"Conversion rate configurations for each tier.\n\nPoints are awarded proportionally to the amount spent.\n\nFormula: `(amount spent) / (money_amount * points)`.","maxItems":21,"title":"configs","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.ConversionRateConfig"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"field":{"description":"Specifies which field in the Wix automations [trigger payload](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/business-management/automations/introduction#how-do-automations-work) to use for calculating points in conversion rate rules.\nFor example, if set to \"priceSummary.totalAmount\", the rule uses the total order amount to calculate loyalty points to be awarded.\nThis field is only applicable for automated earning rules.","title":"field","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ConversionRate","description":"Conversion rate type of earning rule.\nCustomers earn points based on the amount spent.\nFor example, for every $10 spent, a customer might earn 1 point."},"com.wixpress.loyalty.earningrule.ConversionRateConfig":{"type":"object","properties":{"tierId":{"description":"Tier ID. If empty, the [base tier](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/tiers/introduction) is used.","format":"GUID","readOnly":true,"title":"tierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"moneyAmount":{"description":"The amount of money used as a reference for point calculation.\nPoints are awarded proportionally to the amount spent.\n\nFor example, if set to 10, 1 point is awarded for every 10 units of currency spent (assuming `points` is set to 1).\n\nFormula for points is: `(amount spent) / (money_amount * points)`.","title":"moneyAmount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"points":{"description":"Points given for the specified `money_amount`.\nWorks in conjunction with `money_amount` to define the earning rule.\n\nFor example: If `money_amount` is 20 and `points` is 10:\n- Spending 10 units of currency earns 5 points\n- Spending 20 units of currency earns 10 points\n- Spending 30 units of currency earns 15 points","title":"points","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ConversionRateConfig","description":""},"com.wixpress.loyalty.earningrule.StatusEnum.Status":{"type":"string","description":"","title":"Status","enum":["UNKNOWN","ACTIVE","PAUSED"]},"google.protobuf.UInt64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UInt64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"com.wixpress.loyalty.earningrule.Metadata":{"type":"object","properties":{"canBeDeleted":{"description":"Whether the earning rule can be deleted.","title":"canBeDeleted","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Metadata","description":""},"com.wixpress.loyalty.earningrule.EarningRuleDisabled":{"type":"object","properties":{},"title":"EarningRuleDisabled","description":""},"com.wixpress.loyalty.earningrule.CreateLoyaltyEarningRuleRequest":{"type":"object","properties":{"earningRule":{"description":"Earning rule to create.","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","summary":"earningRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateLoyaltyEarningRuleRequest","description":""},"com.wixpress.loyalty.earningrule.CreateLoyaltyEarningRuleResponse":{"type":"object","properties":{"earningRule":{"description":"Created earning rule.","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","summary":"earningRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateLoyaltyEarningRuleResponse","description":""},"com.wixpress.loyalty.earningrule.BulkCreateLoyaltyEarningRulesRequest":{"type":"object","properties":{"earningRules":{"description":"Earning rules to create.","minItems":1,"maxItems":100,"title":"earningRules","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateLoyaltyEarningRulesRequest","description":""},"com.wixpress.loyalty.earningrule.BulkCreateLoyaltyEarningRulesResponse":{"type":"object","properties":{"results":{"description":"Created earning rules.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.BulkLoyaltyEarningRuleResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Additional metadata for the created earning rules.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateLoyaltyEarningRulesResponse","description":""},"com.wixpress.loyalty.earningrule.BulkLoyaltyEarningRuleResult":{"type":"object","properties":{"itemMetadata":{"description":"Additional metadata for the created earning rules.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Created earning rule.","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkLoyaltyEarningRuleResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"com.wixpress.loyalty.earningrule.GetLoyaltyEarningRuleRequest":{"type":"object","properties":{"id":{"description":"ID of the earning rule to retrieve.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetLoyaltyEarningRuleRequest","description":""},"com.wixpress.loyalty.earningrule.GetLoyaltyEarningRuleResponse":{"type":"object","properties":{"earningRule":{"description":"Retrieved earning rule.","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","summary":"earningRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetLoyaltyEarningRuleResponse","description":""},"com.wixpress.loyalty.earningrule.GetAutomationEarningRuleRequest":{"type":"object","properties":{"id":{"description":"ID of the earning rule to retrieve.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetAutomationEarningRuleRequest","description":""},"com.wixpress.loyalty.earningrule.GetAutomationEarningRuleResponse":{"type":"object","properties":{"earningRule":{"description":"Retrieved earning rule.","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","summary":"earningRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetAutomationEarningRuleResponse","description":""},"com.wixpress.loyalty.earningrule.UpdateLoyaltyEarningRuleRequest":{"type":"object","properties":{"earningRule":{"description":"Earning rule to update.","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","summary":"earningRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateLoyaltyEarningRuleRequest","description":""},"com.wixpress.loyalty.earningrule.UpdateLoyaltyEarningRuleResponse":{"type":"object","properties":{"earningRule":{"description":"The updated earning rule.","$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule","summary":"earningRule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateLoyaltyEarningRuleResponse","description":""},"com.wixpress.loyalty.earningrule.DeleteLoyaltyEarningRuleRequest":{"type":"object","properties":{"id":{"description":"ID of the earning rule to delete.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision of the earning rule. Incremented by 1 each time the earning rule is updated.\nPass the latest revision when updating to prevent conflicting changes.","title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteLoyaltyEarningRuleRequest","description":""},"com.wixpress.loyalty.earningrule.DeleteLoyaltyEarningRuleResponse":{"type":"object","properties":{},"title":"DeleteLoyaltyEarningRuleResponse","description":""},"com.wixpress.loyalty.earningrule.DeleteAutomationEarningRuleRequest":{"type":"object","properties":{"id":{"description":"ID of the earning rule to delete.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteAutomationEarningRuleRequest","description":""},"com.wixpress.loyalty.earningrule.DeleteAutomationEarningRuleResponse":{"type":"object","properties":{},"title":"DeleteAutomationEarningRuleResponse","description":""},"com.wixpress.loyalty.earningrule.ListEarningRulesRequest":{"type":"object","properties":{"triggerAppId":{"description":"App ID that triggers the point assignment. For example, `9a5d83fd-8570-482e-81ab-cfa88942ee60`.","title":"triggerAppId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggerActivityType":{"description":"Type of activity that triggers the point assignment. For example, `restaurants-order-is-pending`.","title":"triggerActivityType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListEarningRulesRequest","description":""},"com.wixpress.loyalty.earningrule.ListEarningRulesResponse":{"type":"object","properties":{"earningRules":{"description":"Retrieved earning rules.","title":"earningRules","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListEarningRulesResponse","description":""},"com.wixpress.loyalty.earningrule.ListEarningRulesInTierRequest":{"type":"object","properties":{"tierId":{"description":"ID of the tier for which the earning rules will be returned.","format":"GUID","title":"tierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"Pagination options.","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListEarningRulesInTierRequest","description":""},"wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.loyalty.earningrule.ListEarningRulesInTierResponse":{"type":"object","properties":{"earningRules":{"description":"Retrieved earning rules.","title":"earningRules","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.earningrule.LoyaltyEarningRule"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListEarningRulesInTierResponse","description":""},"wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Loyalty Earning Rule","description":"A loyalty earning rule defines how customers earn points in a loyalty program.\nYou can create rules for different activities, such as making purchases.","fqdn":"wix.loyalty.v1.loyalty_earning_rule"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Earning Rules API allows you to manage earning rules for your loyalty program. Earning rules define how customers earn points through various activities, such as making purchases or registering for events.\n\nWith the Earning Rules API, you can:\n\n+ [Create loyalty earning rules](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/create-loyalty-earning-rule) to set up new rules for earning points.\n+ [List earning rules](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/list-earning-rules) to retrieve all earning rules in your loyalty program.\n+ [Bulk create loyalty earning rules](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/bulk-create-loyalty-earning-rules) to set up multiple earning rules at once.\n+ [Update loyalty earning rules](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/update-loyalty-earning-rule) to modify existing earning rules.\n+ [Delete loyalty earning rules](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/delete-loyalty-earning-rule) to remove earning rules that are no longer needed.\n+ [Delete automation earning rules](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/delete-automation-earning-rule) to remove automated earning rules.\n\nFor more information about managing loyalty programs, see the [Loyalty API](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/introduction). To learn more about earning rules, see [Managing Your Loyalty Program](fallback::https://support.wix.com/en/article/wix-loyalty-program-managing-your-loyalty-program).\n\n## Earning Rules and Points Calculation\n\nAn earning rule defines how customers receive loyalty points for specific actions they take on your site, such as making a purchase or booking an appointment. Customers accumulate these loyalty points and can later exchange them for rewards like discounts or free shipping at checkout.\n\nEarning rules use two methods to calculate loyalty points:\n\n+ **Fixed amount**: Awards a set number of points for a specific action. \n Example: A customer receives 10 points for purchasing a ticket through Wix Events.\n+ **Conversion rate**: Awards points based on a ratio of money spent to points earned. \n Example: A customer receives 2 points for every $1 spent in your online store.\n \n The formula is: `points awarded = (amount spent / moneyAmount) * points per unit`.\n \n For a $100 purchase with 2 points awarded per $1 spent: \n `points awarded = (100 / 1) * 2 = 200 points`\n\nOnce customers accumulate loyalty points, they can redeem them for various rewards during the checkout process. For example, exchanging 500 points for a 10% discount on their purchase.\n\n## Types of earning rules\n\nThe Wix Loyalty program supports two types of earning rules:\n\n+ Non-automated earning rules.\n+ Automated earning rules.\n\nBoth types allow customers to earn points for various actions, but differ in their flexibility and customization options:\n\n+ Non-automated earning rules are limited to a fixed set of supported rules (see tables below) based on installed Wix business solutions.\n+ Automated earning rules, powered by Wix Automations, allow for unlimited custom earning rule creation.\n\nWe recommend creating automated earning rules using the [Wix Automations API](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/business-management/automations/introduction) for maximum flexibility and customization options.\n\n### Automated earning rules\n\nAutomated earning rules are managed by [Wix Automations](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/business-management/automations/introduction), a system that enables custom workflows across Wix apps. These rules offer more flexibility and can be triggered by a wide range of events.\n\nThere are two subtypes of automated earning rules:\n\n+ Pre-installed rules.\n+ Custom rules.\n\n#### Pre-installed rules\n\nPre-installed rules come automatically when certain business solutions are installed. These rules can be paused but not deleted.\n\nSupported pre-installed earning rules:\n\n| Earning Rule Name | Trigger | Point award method |\n|-----------|---------------|-----------------|\n| Order a plan (Wix Pricing Plans) | `wix_pricing_plans-plan_purchased` | Fixed amount, Conversion rate |\n| Place a restaurant order (Old Wix Restaurants) | `wix_restaurants_orders-order_submitted` | Conversion rate only |\n| Place a restaurant order (New Wix Restaurants) | `restaurants-order-is-pending` | Conversion rate only |\n\n#### Custom rules\n\nCustom rules are created by site owners and don't come pre-installed. Automated earning rules not listed above fall into this category.\n\nFor example, if Wix Bookings is installed, you can create a custom automated earning rule that is triggered when a customer books a session.\n\n### Non-automated earning rules\n\nNon-automated earning rules can be created based on installed Wix business solutions. These rules are identified by their `sourceAppId`, which is the Loyalty app ID for non-automated rules.\n\nSupported non-automated earning rules:\n\n| Earning Rule Name | Trigger | Point award method |\n|-----------|---------------|-----------------|\n| Purchase a product (Wix Stores) | `stores/OrderPaid` | Fixed amount, Conversion rate |\n| Book a session (Wix Bookings) | `bookings/BookingConfirmed` | Fixed amount only |\n| Buy a ticket (Wix Events) | `events/OrderConfirmed` | Fixed amount, Conversion rate |\n| RSVP to an event (Wix Events) | `events/Rsvp` | Fixed amount only |\n\n\nFor example, if Wix Events is installed, two types of earning rules can be created:\n+ A rule that awards points when a customer buys a ticket (triggered by `events/OrderConfirmed`).\n+ A rule that awards points when a customer RSVPs to a free event (triggered by `events/Rsvp`).\n\n\nThese non-automated rules provide a way to set up basic loyalty rewards without the Wix automations setup. They are useful for implementing a straightforward points system based on common customer actions within Wix apps.\n\n## Wix Automations and Earning Rules\n\nAutomated earning rules are powered by [Wix Automations](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/business-management/automations/introduction), a system that enables custom workflows across Wix apps.\n\nWix Automations are built on two key concepts:\n\n- **Triggers**: Events that initiate automations.\n- **Actions**: Responses to triggers.\n\nTo create and manage automated earning rules, you'll use the Wix Automations API. This API allows you to define custom triggers, implement action logic, and activate automations.\n\nFor more information on working with Wix Automations, see the [Automations API Introduction](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/business-management/automations/introduction).\n\n## Terminology\n\n+ __Earning rule__: A condition that, when met, awards loyalty points to a customer. All earning rules allow customers to earn points for performing certain actions.\n+ __Non-Automated earning rule__: An earning rule set up for specific business solutions, identified by its `sourceAppId`.\n+ __Automated earning rule__: An earning rule powered by Wix Automations, which can be pre-installed or custom:\n - __Pre-installed__: An automated earning rule that comes by default with certain services, which can be paused but not deleted.\n - __Custom__: An automated earning rule created by the site owner that is not pre-installed by default. Custom rules can be deleted.\n+ __Fixed amount__: An earning rule type where a set number of points is awarded for a specific action. For example, a customer might receive 10 points for purchasing a ticket through Wix Events.\n+ __Conversion rate__: An earning rule type where points are awarded based on a ratio of money spent to points earned. The formula is: `points awarded = (amount spent / moneyAmount) * points per unit`.\n+ __Trigger app ID__: The ID of the app that initiates the point assignment. For example: Stores, Bookings, Events.\n+ __Trigger activity type__: The specific action that triggers point assignment. For example: `auth/register`, `events/OrderConfirmed`.\n+ __Source app ID__: The ID of the app managing the rule. This field indicates whether an earning rule is automated or non-automated. If the `sourceAppId` is the Loyalty app ID, it's a non-automated earning rule. If it's the Wix Automations app ID, it's an automated earning rule.\n+ __Tier__: A tier is a loyalty level that customers are assigned to based on the number of points they earn. Customers in different tiers may earn points at different rates for the same activity. For example, a higher tier member might earn more points per purchase than a lower tier member.\n+ __Status__: The current state of an earning rule (for example, `ACTIVE`, `PAUSED`)."}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}