{"id":"d3c555a7-8283-4ccd-91b1-a65c8d03d750","createdDate":"2024-05-13T15:01:23.476Z","updatedDate":"2024-05-13T15:01:23.476Z","resourceId":"853543d6-16e5-487b-995f-1e1ddcf3c385","api":{"schema":{"object":{"displayName":"Tier Object","description":"A tier is a loyalty level that customers are assigned to based on the amount of points they earn.\nRead more about loyalty tiers [here](https://support.wix.com/en/article/about-tiers).","slug":"tier-object","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","legacyExamples":[{"title":"Tier","content":"{\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"\"\n },\n \"requiredPoints\": 200,\n \"revision\": \"2\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"methods":[{"summary":"List Tiers","description":"Retrieves a list of a site's tiers.\n\nTo retrieve a specific tier, use [Get Tier](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/tiers/get-tier).","operationId":"com.wixpress.loyalty.tier.LoyaltyTiers.ListTiers","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.ListTiersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-tiers","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-tiers","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_TIERS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.ListTiersRequest","responseMessage":"com.wixpress.loyalty.tier.ListTiersResponse"},"legacyExamples":[{"name":"ListTiers","type":"METHOD","content":{"title":"List tiers","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers' \\\n -H 'Authorization: '","response":"{\n \"tiers\": [\n {\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\"\n },\n \"requiredPoints\": 200,\n \"revision\": \"1\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/tiers","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_TIERS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.ListTiersRequest","responseMessage":"com.wixpress.loyalty.tier.ListTiersResponse"},"legacyExamples":[{"name":"ListTiers","type":"METHOD","content":{"title":"List tiers","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers' \\\n -H 'Authorization: '","response":"{\n \"tiers\": [\n {\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\"\n },\n \"requiredPoints\": 200,\n \"revision\": \"1\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"List Tiers","slugifiedName":"list-tiers"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"isAdminMethod":false},{"summary":"Create Tier","description":"Creates a tier.\n\nThe name for a tier and the amount of required points to qualify for a tier can only exist for a single tier.\nAttempts to create a tier with a `tierDefinition.name` or `requiredPoints` that already exists will return an error.\n\nTo create up to 20 tiers at once, use [Bulk Create Tiers](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/tiers/bulk-create-tiers).\n\n>**Note:** You must have a [Business VIP Premium plan](https://support.wix.com/en/article/business-vip-premium-plan-overview)\n>or a [Scale Premium plan](https://support.wix.com/en/article/editor-x-scale-premium-plan-overview) to add tiers.","operationId":"com.wixpress.loyalty.tier.LoyaltyTiers.CreateTier","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.CreateTierResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-tiers","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-tiers","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateTierRequest","description":"","properties":{"tier":{"description":"Tier to create.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","summary":"tier","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["tier"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Tier Created","description":"Triggered when a tier is created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.tier","serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.tier_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_TIERS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.CreateTierRequest","responseMessage":"com.wixpress.loyalty.tier.CreateTierResponse"},"legacyExamples":[{"name":"CreateTier","type":"METHOD","content":{"title":"Create tier","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"tier\": {\n \"tierDefinition\": {\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\",\n \"icon\": {\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\"\n }\n },\n \"requiredPoints\": 200\n }\n }'","response":"{\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\"\n },\n \"requiredPoints\": 200,\n \"revision\": \"1\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/tiers","rpcOnly":false,"triggeredEvents":[{"title":"Tier Created","description":"Triggered when a tier is created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.tier","serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.tier_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_TIERS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.CreateTierRequest","responseMessage":"com.wixpress.loyalty.tier.CreateTierResponse"},"legacyExamples":[{"name":"CreateTier","type":"METHOD","content":{"title":"Create tier","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"tier\": {\n \"tierDefinition\": {\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\",\n \"icon\": {\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\"\n }\n },\n \"requiredPoints\": 200\n }\n }'","response":"{\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\"\n },\n \"requiredPoints\": 200,\n \"revision\": \"1\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Create Tier","slugifiedName":"create-tier"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Bulk Create Tiers","description":"Creates up to 20 tiers.\n\nThe name for a tier and the amount of required points to qualify for a tier can only exist for a single tier.\nAttempts to create a tier with a `tierDefinition.name` or `requiredPoints` that already exists will return an error.\n\nTo create a single tier, use [Create Tier](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/tiers/create-tier).\n\n>**Note:** You must have a [Business VIP Premium plan](https://support.wix.com/en/article/business-vip-premium-plan-overview)\n>or a [Scale Premium plan](https://support.wix.com/en/article/editor-x-scale-premium-plan-overview) to add tiers.","operationId":"com.wixpress.loyalty.tier.LoyaltyTiers.BulkCreateTiers","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.BulkCreateTiersResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-tiers","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-tiers","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkCreateTiersRequest","description":"","properties":{"tiers":{"description":"Tiers to create.","minItems":1,"maxItems":20,"title":"tiers","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Tier Created","description":"Triggered when a tier has been created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.tier","serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.tier_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_TIERS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.BulkCreateTiersRequest","responseMessage":"com.wixpress.loyalty.tier.BulkCreateTiersResponse"},"legacyExamples":[{"name":"BulkCreateTiers","type":"METHOD","content":{"title":"Bulk create tiers","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-tiers/v1/bulk/tiers/create' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"tiers\": [\n {\n \"tierDefinition\": {\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\",\n \"icon\": {\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\"\n }\n },\n \"requiredPoints\": 200\n }\n ]\n }'","response":"{\n \"results\": [\n {\n \"item\": {\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\"\n },\n \"requiredPoints\": 200,\n \"revision\": \"1\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n },\n \"itemMetadata\": {\n \"id\": \"d7dfacd5-8141-456b-b278-6383b97f2569\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\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/tiers/create","rpcOnly":false,"triggeredEvents":[{"title":"Tier Created","description":"Triggered when a tier has been created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.tier","serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.tier_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_TIERS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.BulkCreateTiersRequest","responseMessage":"com.wixpress.loyalty.tier.BulkCreateTiersResponse"},"legacyExamples":[{"name":"BulkCreateTiers","type":"METHOD","content":{"title":"Bulk create tiers","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-tiers/v1/bulk/tiers/create' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"tiers\": [\n {\n \"tierDefinition\": {\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\",\n \"icon\": {\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\"\n }\n },\n \"requiredPoints\": 200\n }\n ]\n }'","response":"{\n \"results\": [\n {\n \"item\": {\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\"\n },\n \"requiredPoints\": 200,\n \"revision\": \"1\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n },\n \"itemMetadata\": {\n \"id\": \"d7dfacd5-8141-456b-b278-6383b97f2569\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\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 Tiers","slugifiedName":"bulk-create-tiers"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Get Tier","description":"Retrieves a loyalty tier.\n\nTo retrieve a list of all of a site's tiers, use [List Tiers](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/tiers/list-tiers).","operationId":"com.wixpress.loyalty.tier.LoyaltyTiers.GetTier","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"tierId","description":"ID of the tier to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.GetTierResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-tiers","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-tiers","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_TIERS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.GetTierRequest","responseMessage":"com.wixpress.loyalty.tier.GetTierResponse"},"legacyExamples":[{"name":"GetTier","type":"METHOD","content":{"title":"Get tier","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/acddc0e0-5e27-4a1b-a52d-b3785ac258cb' \\\n -H 'Authorization: '","response":"{\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\"\n },\n \"requiredPoints\": 200,\n \"revision\": \"1\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/tiers/{tierId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_TIERS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.GetTierRequest","responseMessage":"com.wixpress.loyalty.tier.GetTierResponse"},"legacyExamples":[{"name":"GetTier","type":"METHOD","content":{"title":"Get tier","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/acddc0e0-5e27-4a1b-a52d-b3785ac258cb' \\\n -H 'Authorization: '","response":"{\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\"\n },\n \"requiredPoints\": 200,\n \"revision\": \"1\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Tier","slugifiedName":"get-tier"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"isAdminMethod":false},{"summary":"Delete Tier","description":"Deletes a loyalty tier.","operationId":"com.wixpress.loyalty.tier.LoyaltyTiers.DeleteTier","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"tierId","description":"ID of the tier to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"revision","in":"query","description":"Current `revision` of the tier to delete.","required":false,"schema":{"description":"Current `revision` of the tier to delete.","title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.DeleteTierResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-tiers","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-tiers","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Tier Deleted","description":"Triggered when a tier is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.loyalty.v1.tier","serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.tier_deleted","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_TIERS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.DeleteTierRequest","responseMessage":"com.wixpress.loyalty.tier.DeleteTierResponse"},"legacyExamples":[{"name":"DeleteTier","type":"METHOD","content":{"title":"Create tier","request":"curl -X DELETE \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/acddc0e0-5e27-4a1b-a52d-b3785ac258cb?revision=1' \\\n -H 'Authorization: '","response":"{\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"delete","path":"/v1/tiers/{tierId}","rpcOnly":false,"triggeredEvents":[{"title":"Tier Deleted","description":"Triggered when a tier is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.loyalty.v1.tier","serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.tier_deleted","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_TIERS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.DeleteTierRequest","responseMessage":"com.wixpress.loyalty.tier.DeleteTierResponse"},"legacyExamples":[{"name":"DeleteTier","type":"METHOD","content":{"title":"Create tier","request":"curl -X DELETE \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/acddc0e0-5e27-4a1b-a52d-b3785ac258cb?revision=1' \\\n -H 'Authorization: '","response":"{\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Delete Tier","slugifiedName":"delete-tier"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Update Tier","description":"Updates a loyalty tier.\n\nUse this endpoint to update tier-specific settings, such as the name and the required points\nthreshold of an individual loyalty tier. To update global settings that apply to all of a site's loyalty tiers,\nuse [Update Tiers Program Settings](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/tiers/update-tiers-program-settings).","operationId":"com.wixpress.loyalty.tier.LoyaltyTiers.UpdateTier","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"tier.id","description":"Tier ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.UpdateTierResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-tiers","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-tiers","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateTierRequest","description":"","properties":{"tier":{"description":"Tier details to update.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","summary":"tier","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["tier","tier.id","tier.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Tier Updated","description":"Triggered when a tier is updated.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.tier","serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.tier_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_TIERS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.UpdateTierRequest","responseMessage":"com.wixpress.loyalty.tier.UpdateTierResponse"},"legacyExamples":[{"name":"UpdateTier","type":"METHOD","content":{"title":"Update tier","request":"curl -X PATCH \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/acddc0e0-5e27-4a1b-a52d-b3785ac258cb' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"tier\": {\n \"tierDefinition\": {\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\",\n \"icon\": {\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\"\n }\n },\n \"requiredPoints\": 400\n }\n }'","response":"{\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\"\n },\n \"requiredPoints\": 400,\n \"revision\": \"2\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"patch","path":"/v1/tiers/{tier.id}","rpcOnly":false,"triggeredEvents":[{"title":"Tier Updated","description":"Triggered when a tier is updated.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.tier","serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.tier_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_TIERS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.UpdateTierRequest","responseMessage":"com.wixpress.loyalty.tier.UpdateTierResponse"},"legacyExamples":[{"name":"UpdateTier","type":"METHOD","content":{"title":"Update tier","request":"curl -X PATCH \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/acddc0e0-5e27-4a1b-a52d-b3785ac258cb' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"tier\": {\n \"tierDefinition\": {\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\",\n \"icon\": {\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\"\n }\n },\n \"requiredPoints\": 400\n }\n }'","response":"{\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\"\n },\n \"requiredPoints\": 400,\n \"revision\": \"2\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Update Tier","slugifiedName":"update-tier"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Get Tiers Program Settings","description":"Retrieves the settings for the tiers program.\n\nTiers program settings apply globally to all tiers in the program.","operationId":"com.wixpress.loyalty.tier.LoyaltyTiers.GetTiersProgramSettings","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.GetTiersProgramSettingsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-tiers","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-tiers","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_TIERS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.GetTiersProgramSettingsRequest","responseMessage":"com.wixpress.loyalty.tier.GetTiersProgramSettingsResponse"},"legacyExamples":[{"name":"GetTiersProgramSettings","type":"METHOD","content":{"title":"Get tiers program settings","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/program-settings \\\n -H 'Authorization: '","response":"{\n \"programSettings\": {\n \"status\": \"ACTIVE\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-02-09T09:06:21.823Z\",\n \"updatedDate\": \"2024-04-17T14:23:22.985Z\",\n \"baseTierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Basic\",\n \"description\": \"Basic tier\"\n },\n \"rollingWindow\": {\n \"durationInMonths\": 12\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/tiers/program-settings","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_TIERS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.GetTiersProgramSettingsRequest","responseMessage":"com.wixpress.loyalty.tier.GetTiersProgramSettingsResponse"},"legacyExamples":[{"name":"GetTiersProgramSettings","type":"METHOD","content":{"title":"Get tiers program settings","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/program-settings \\\n -H 'Authorization: '","response":"{\n \"programSettings\": {\n \"status\": \"ACTIVE\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-02-09T09:06:21.823Z\",\n \"updatedDate\": \"2024-04-17T14:23:22.985Z\",\n \"baseTierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Basic\",\n \"description\": \"Basic tier\"\n },\n \"rollingWindow\": {\n \"durationInMonths\": 12\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Tiers Program Settings","slugifiedName":"get-tiers-program-settings"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"isAdminMethod":false},{"summary":"Create Tiers Program Settings","description":"Create tiers program settings.\n\nTiers program settings apply globally to all tiers in the program.","operationId":"com.wixpress.loyalty.tier.LoyaltyTiers.CreateTiersProgramSettings","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.CreateTiersProgramSettingsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-tiers","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-tiers","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateTiersProgramSettingsRequest","description":"","properties":{"programSettings":{"description":"Tiers program settings.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.TiersProgramSettings","summary":"programSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["programSettings"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_TIERS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.CreateTiersProgramSettingsRequest","responseMessage":"com.wixpress.loyalty.tier.CreateTiersProgramSettingsResponse"},"legacyExamples":[{"name":"CreateTiersProgramSettings","type":"METHOD","content":{"title":"Create tiers program settings","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/program-settings' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"programSettings\": {\n \"status\": \"ACTIVE\",\n \"baseTierDefinition\": {\n \"name\": \"Basic\",\n \"description\": \"Basic tier\",\n \"icon\": {\n \"url\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\"\n }\n },\n \"rollingWindow\": {\n \"durationInMonths\": 12\n }\n }\n }'","response":"{\n \"programSettings\": {\n \"status\": \"ACTIVE\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-02-09T09:06:21.823Z\",\n \"updatedDate\": \"2024-04-17T14:23:22.985Z\",\n \"baseTierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Basic\",\n \"description\": \"Basic tier\"\n },\n \"rollingWindow\": {\n \"durationInMonths\": 12\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/tiers/program-settings","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_TIERS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.CreateTiersProgramSettingsRequest","responseMessage":"com.wixpress.loyalty.tier.CreateTiersProgramSettingsResponse"},"legacyExamples":[{"name":"CreateTiersProgramSettings","type":"METHOD","content":{"title":"Create tiers program settings","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/program-settings' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"programSettings\": {\n \"status\": \"ACTIVE\",\n \"baseTierDefinition\": {\n \"name\": \"Basic\",\n \"description\": \"Basic tier\",\n \"icon\": {\n \"url\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\"\n }\n },\n \"rollingWindow\": {\n \"durationInMonths\": 12\n }\n }\n }'","response":"{\n \"programSettings\": {\n \"status\": \"ACTIVE\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-02-09T09:06:21.823Z\",\n \"updatedDate\": \"2024-04-17T14:23:22.985Z\",\n \"baseTierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Basic\",\n \"description\": \"Basic tier\"\n },\n \"rollingWindow\": {\n \"durationInMonths\": 12\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Create Tiers Program Settings","slugifiedName":"create-tiers-program-settings"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Update Tiers Program Settings","description":"Updates the global settings of a loyalty tier program.\n\nUse this endpoint to update settings that apply to all of a site's loyalty tiers.\nTo update tier-specific settings for an individual tier, use\n[Update Tier](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/docs/rest/crm/loyalty-program/tiers/update-tier).\n\nBy default, the `status` of a tiers program is set to `DISABLED` and must be manually updated to `ACTIVE` using\nthis endpoint or through a site owner's [dashboard](https://manage.wix.com/account/site-selector/?actionUrl=https%3A%2F%2Fwww.wix.com%2Fdashboard%2F%7BmetaSiteId%7D%2Floyalty-accounts%2Fmanage%3Ftab%3Dpoints-and-rewards&title=Select+a+Site&primaryButtonText=Select+Site).\n\n>**Note:** The `status`, `revision`, and `rollingWindow` parameters must be passed to update the tiers program settings.\n>The `baseTierDefinition` fields are not required, however, if you don't pass them they will reset to\n>their default values of empty fields.","operationId":"com.wixpress.loyalty.tier.LoyaltyTiers.UpdateTiersProgramSettings","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.UpdateTiersProgramSettingsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-tiers","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-tiers","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateTiersProgramSettingsRequest","description":"","properties":{"programSettings":{"description":"Settings for the tiers program.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.TiersProgramSettings","summary":"programSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["programSettings","programSettings.revision","programSettings.status","programSettings.period"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_TIERS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.UpdateTiersProgramSettingsRequest","responseMessage":"com.wixpress.loyalty.tier.UpdateTiersProgramSettingsResponse"},"legacyExamples":[{"name":"UpdateTiersProgramSettings","type":"METHOD","content":{"title":"Update tiers program settings","request":"curl -X PATCH \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/program-settings' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"programSettings\": {\n \"status\": \"PAUSED\",\n \"revision\": \"1\",\n \"baseTierDefinition\": {\n \"name\": \"Basic\",\n \"description\": \"Basic tier\",\n \"icon\": {\n \"url\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\"\n }\n },\n \"rollingWindow\": {\n \"durationInMonths\": 12\n }\n }\n }'","response":"{\n \"programSettings\": {\n \"status\": \"PAUSED\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-02-09T09:06:21.823Z\",\n \"updatedDate\": \"2024-04-17T14:23:22.985Z\",\n \"baseTierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Basic\",\n \"description\": \"Basic tier\"\n },\n \"rollingWindow\": {\n \"durationInMonths\": 12\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"patch","path":"/v1/tiers/program-settings","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_TIERS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.UpdateTiersProgramSettingsRequest","responseMessage":"com.wixpress.loyalty.tier.UpdateTiersProgramSettingsResponse"},"legacyExamples":[{"name":"UpdateTiersProgramSettings","type":"METHOD","content":{"title":"Update tiers program settings","request":"curl -X PATCH \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/program-settings' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"programSettings\": {\n \"status\": \"PAUSED\",\n \"revision\": \"1\",\n \"baseTierDefinition\": {\n \"name\": \"Basic\",\n \"description\": \"Basic tier\",\n \"icon\": {\n \"url\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\"\n }\n },\n \"rollingWindow\": {\n \"durationInMonths\": 12\n }\n }\n }'","response":"{\n \"programSettings\": {\n \"status\": \"PAUSED\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-02-09T09:06:21.823Z\",\n \"updatedDate\": \"2024-04-17T14:23:22.985Z\",\n \"baseTierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Basic\",\n \"description\": \"Basic tier\"\n },\n \"rollingWindow\": {\n \"durationInMonths\": 12\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Update Tiers Program Settings","slugifiedName":"update-tiers-program-settings"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Get Tiers Program","description":"Returns `Tiers` and `ProgramSettings` in a single response.\n\nIf `TiersProgramSettings` doesn't exist, default `TiersProgramSettings` are created.","operationId":"com.wixpress.loyalty.tier.LoyaltyTiers.GetTiersProgram","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.GetTiersProgramResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-tiers","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-tiers","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_TIERS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.GetTiersProgramRequest","responseMessage":"com.wixpress.loyalty.tier.GetTiersProgramResponse"},"legacyExamples":[{"name":"GetTiersProgram","type":"METHOD","content":{"title":"Get tiers program","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/program \\\n -H 'Authorization: '","response":"{\n \"tiers\": [\n {\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\"\n },\n \"requiredPoints\": 200,\n \"revision\": \"2\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n }\n ],\n \"programSettings\": {\n \"status\": \"ACTIVE\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-02-09T09:06:21.823Z\",\n \"updatedDate\": \"2024-04-17T14:23:22.985Z\",\n \"baseTierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Basic\",\n \"description\": \"Basic tier\"\n },\n \"rollingWindow\": {\n \"durationInMonths\": 12\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/tiers/program","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_TIERS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-tiers","serviceArtifactId":"com.wixpress.loyalty.loyalty-tiers","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.tier.GetTiersProgramRequest","responseMessage":"com.wixpress.loyalty.tier.GetTiersProgramResponse"},"legacyExamples":[{"name":"GetTiersProgram","type":"METHOD","content":{"title":"Get tiers program","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-tiers/v1/tiers/program \\\n -H 'Authorization: '","response":"{\n \"tiers\": [\n {\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"tierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Gold\",\n \"description\": \"Earn 2x points and get special discount\"\n },\n \"requiredPoints\": 200,\n \"revision\": \"2\",\n \"createdDate\": \"2024-02-15T14:22:02.539Z\",\n \"updatedDate\": \"2024-04-17T11:34:25.274Z\"\n }\n ],\n \"programSettings\": {\n \"status\": \"ACTIVE\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-02-09T09:06:21.823Z\",\n \"updatedDate\": \"2024-04-17T14:23:22.985Z\",\n \"baseTierDefinition\": {\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg\",\n \"height\": 0,\n \"width\": 0\n },\n \"name\": \"Basic\",\n \"description\": \"Basic tier\"\n },\n \"rollingWindow\": {\n \"durationInMonths\": 12\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Tiers Program","slugifiedName":"get-tiers-program"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"isAdminMethod":false}],"webhooks":[{"summary":"Tier Created","title":"Tier Created","description":"Triggered when a tier has been created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.tier","serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.tier_created","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","contentLink":{"displayName":"Tier Created","slugifiedName":"tier-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Tier Updated","title":"Tier Updated","description":"Triggered when a tier is updated.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.tier","serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.tier_updated","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","contentLink":{"displayName":"Tier Updated","slugifiedName":"tier-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Tier Deleted","title":"Tier Deleted","description":"Triggered when a tier is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.loyalty.v1.tier","serviceName":"com.wixpress.loyalty.tier.LoyaltyTiers","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.tier_deleted","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","contentLink":{"displayName":"Tier Deleted","slugifiedName":"tier-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Loyalty Tiers API allows you to create a levels-based program that assigns loyalty accounts to different tiers based on the amount of points they have earned. \n\nWith the Loyalty Tiers API, you can:\n- [Create](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/tiers/create-tier) and [update](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/tiers/update-tier) individual tiers.\n- [Update](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/tiers/update-tiers-program-settings) settings that apply globally to the tiers program. \n\nFor more information about loyalty tiers, see [Adding Tiers to Your Loyalty Program](fallback::https://support.wix.com/en/article/wix-loyalty-program-adding-tiers-to-your-loyalty-program). \n\n## Before you begin \n\nIt's important to note the following points before starting to code:\n- The site must have a [Business VIP Premium Plan](fallback::https://support.wix.com/en/article/business-vip-premium-plan-overview) or a [Scale Premium Plan](fallback::https://support.wix.com/en/article/editor-x-scale-premium-plan-overview) to add tiers.\n- The site must have at least one of these apps: Wix Bookings, Wix Events, Wix Pricing Plans, or Wix Stores.\n >**Note:** Currently, tiers cannot be added to Wix Restaurants loyalty programs.\n- The tiers program `status` must be manually set to `ACTIVE`. Use [Update Tiers Program Settings](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/tiers/update-tiers-program-settings) to update the `status` or enable tiers from a site owner's [dashboard](fallback::https://manage.wix.com/account/site-selector/?actionUrl=https%3A%2F%2Fwww.wix.com%2Fdashboard%2F%7BmetaSiteId%7D%2Floyalty-accounts%2Fmanage%3Ftab%3Dpoints-and-rewards&title=Select+a+Site&primaryButtonText=Select+Site).\n- The Loyalty Tiers API does not handle rules for earning points based on your tier. A site owner may adjust those settings from their dashboard. See [Assign ways to earn to each tier](fallback::https://support.wix.com/en/article/wix-loyalty-program-adding-tiers-to-your-loyalty-program#step-2-assign-ways-to-earn-and-rewards-to-each-tier).\n\n## Terminology \n\n- **Tiers program settings:** Settings that apply globally to the overall tiers program. \n- **Base tier:** A default tier for any loyalty account that is unassigned for not meeting the required points threshold of any other tier. The base tier requires `0` points, has no `tierId`, and is not returned as a tier when [List Tiers](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/tiers/list-tiers) is called. When a tiers program status is `PAUSED` or `DISABLED` all of the loyalty accounts are assigned to the base tier.\n- **Rolling window:** Period of time used to calculate loyalty points for tier assignment. The total points earned and adjusted during this period determine if the account meets a tier's required point threshold. The window is recalculated every 15 minutes or if a new tier event triggers.\n- **Points earned and adjusted:** Tier assignment is based on the total amount of loyalty points earned and adjusted over the period of time in a `rollingWindow`. If an account redeems points during that period, the points that were earned still count towards tier assignment even if that leaves the remaining points balance below the tier's required point threshold. Similarly, if the current points balance for a loyalty account is above a tier's required points threshold, but those points were earned in a time period earlier than the `rollingWindow` then those points are not considered for tier assignment.\n","sourceRepo":"git@github.com:wix-private/app-market.git","path":"proto/docs/introduction.md"}],"components":{"schemas":{"com.wixpress.loyalty.tier.Tier":{"type":"object","properties":{"id":{"description":"Tier ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tierDefinition":{"description":"Information about the tier.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.TierDefinition","summary":"tierDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"requiredPoints":{"description":"The amount of points required to be in this tier.","minimum":0,"maximum":9999999,"title":"requiredPoints","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the loyalty tier is updated.\n\nTo prevent conflicting changes, the current `revision` must be passed when updating the loyalty tier.","readOnly":true,"title":"revision","type":"integer","format":"uint64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the tier was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the tier was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Tier","description":"A tier is a loyalty level that customers are assigned to based on the amount of points they earn.\nRead more about loyalty tiers [here](https://support.wix.com/en/article/about-tiers)."},"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.tier.TierDefinition":{"type":"object","properties":{"icon":{"description":"Details about the tier icon.","$ref":"#/components/schemas/wix.common.Image","summary":"icon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Tier name.","minLength":2,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Tier description.","maxLength":70,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TierDefinition","description":"Information about the tier."},"wix.common.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Image URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Original image height.","readOnly":true,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Original image width.","readOnly":true,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Image filename.","readOnly":true,"title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","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":""},"google.protobuf.UInt64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UInt64Value","description":""},"com.wixpress.loyalty.tier.TiersProgramSettingsChanged":{"type":"object","properties":{"programSettings":{"description":"Settings for the tiers program.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.TiersProgramSettings","summary":"programSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TiersProgramSettingsChanged","description":""},"com.wixpress.loyalty.tier.TiersProgramSettings":{"type":"object","properties":{"status":{"description":"Tiers program status.","title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.loyalty.tier.StatusEnum.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the loyalty tiers settings are updated.\n\nTo prevent conflicting changes, the current `revision` must be passed when updating the loyalty tiers settings.","immutable":true,"title":"revision","type":"integer","format":"uint64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the loyalty tiers program was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the loyalty tiers program was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"baseTierDefinition":{"description":"Information about the base loyalty tier.\n\nThe base tier is the default tier for any account that is unassigned for not meeting\nthe required points threshold of any other tier.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.TierDefinition","summary":"baseTierDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TiersProgramSettings","description":"There can be single TiersSettings per site and it's global (i.e. applies to all program's tiers)","oneOf":[{"description":"","summary":"period","$ref":"#/components/schemas/com.wixpress.loyalty.tier.TiersProgramSettings.period"}]},"com.wixpress.loyalty.tier.TiersProgramSettings.period":{"type":"object","title":"period","properties":{"rollingWindow":{"description":"*Required.**\nPeriod of time used to calculate loyalty points for tier assignment.\n\nThe loyalty points accumulated during this period determine if the account meets a tier's required point threshold.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.RollingWindow","summary":"rollingWindow","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.loyalty.tier.StatusEnum.Status":{"type":"string","description":"","title":"Status","enum":["UNKNOWN","DISABLED","DRAFT","ACTIVE","PAUSED"]},"com.wixpress.loyalty.tier.RollingWindow":{"type":"object","properties":{"durationInMonths":{"description":"Number of months to use for the rolling window period.\n\nMin: `12`\n\nMax: `36`","minimum":1,"maximum":36,"title":"durationInMonths","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RollingWindow","description":"*Required.** Period of time used to calculate loyalty points for tier assignment.\n\nThe loyalty points accumulated during this period determine if the account meets a tier's required point threshold."},"com.wixpress.loyalty.tier.TiersRollingUpdate":{"type":"object","properties":{},"title":"TiersRollingUpdate","description":""},"com.wixpress.loyalty.tier.CreateTierRequest":{"type":"object","properties":{"tier":{"description":"Tier to create.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","summary":"tier","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateTierRequest","description":""},"com.wixpress.loyalty.tier.CreateTierResponse":{"type":"object","properties":{"tier":{"description":"Created loyalty tier.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","summary":"tier","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateTierResponse","description":""},"com.wixpress.loyalty.tier.BulkCreateTiersRequest":{"type":"object","properties":{"tiers":{"description":"Tiers to create.","minItems":1,"maxItems":20,"title":"tiers","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateTiersRequest","description":""},"com.wixpress.loyalty.tier.BulkCreateTiersResponse":{"type":"object","properties":{"results":{"description":"Created tiers.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.BulkTierResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateTiersResponse","description":""},"com.wixpress.loyalty.tier.BulkTierResult":{"type":"object","properties":{"itemMetadata":{"description":"Individual tier metadata.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Individual tier information.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkTierResult","description":"Retrieved tiers."},"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.tier.GetTierRequest":{"type":"object","properties":{"tierId":{"description":"ID of the tier to retrieve.","format":"GUID","title":"tierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTierRequest","description":""},"com.wixpress.loyalty.tier.GetTierResponse":{"type":"object","properties":{"tier":{"description":"Retrieved loyalty tier.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","summary":"tier","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTierResponse","description":""},"com.wixpress.loyalty.tier.UpdateTierRequest":{"type":"object","properties":{"tier":{"description":"Tier details to update.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","summary":"tier","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTierRequest","description":""},"com.wixpress.loyalty.tier.UpdateTierResponse":{"type":"object","properties":{"tier":{"description":"Updated loyalty tier.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","summary":"tier","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTierResponse","description":""},"com.wixpress.loyalty.tier.TierRequiredPointsChanged":{"type":"object","properties":{"tier":{"description":"Tier.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier","summary":"tier","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TierRequiredPointsChanged","description":""},"com.wixpress.loyalty.tier.DeleteTierRequest":{"type":"object","properties":{"tierId":{"description":"ID of the tier to delete.","format":"GUID","title":"tierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Current `revision` of the tier to delete.","title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteTierRequest","description":""},"com.wixpress.loyalty.tier.DeleteTierResponse":{"type":"object","properties":{},"title":"DeleteTierResponse","description":""},"com.wixpress.loyalty.tier.ListTiersRequest":{"type":"object","properties":{},"title":"ListTiersRequest","description":""},"com.wixpress.loyalty.tier.ListTiersResponse":{"type":"object","properties":{"tiers":{"description":"Retrieved loyalty tiers.","title":"tiers","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListTiersResponse","description":""},"com.wixpress.loyalty.tier.CreateTiersProgramSettingsRequest":{"type":"object","properties":{"programSettings":{"description":"Tiers program settings.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.TiersProgramSettings","summary":"programSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateTiersProgramSettingsRequest","description":""},"com.wixpress.loyalty.tier.CreateTiersProgramSettingsResponse":{"type":"object","properties":{"programSettings":{"description":"Created tiers program settings.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.TiersProgramSettings","summary":"programSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateTiersProgramSettingsResponse","description":""},"com.wixpress.loyalty.tier.GetTiersProgramRequest":{"type":"object","properties":{},"title":"GetTiersProgramRequest","description":""},"com.wixpress.loyalty.tier.GetTiersProgramResponse":{"type":"object","properties":{"tiers":{"description":"Tiers.","title":"tiers","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.tier.Tier"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"programSettings":{"description":"Tiers program settings.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.TiersProgramSettings","summary":"programSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTiersProgramResponse","description":""},"com.wixpress.loyalty.tier.GetTiersProgramSettingsRequest":{"type":"object","properties":{},"title":"GetTiersProgramSettingsRequest","description":""},"com.wixpress.loyalty.tier.GetTiersProgramSettingsResponse":{"type":"object","properties":{"programSettings":{"description":"Tiers program settings.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.TiersProgramSettings","summary":"programSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTiersProgramSettingsResponse","description":""},"com.wixpress.loyalty.tier.UpdateTiersProgramSettingsRequest":{"type":"object","properties":{"programSettings":{"description":"Settings for the tiers program.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.TiersProgramSettings","summary":"programSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTiersProgramSettingsRequest","description":""},"com.wixpress.loyalty.tier.UpdateTiersProgramSettingsResponse":{"type":"object","properties":{"programSettings":{"description":"Updated program settings.","$ref":"#/components/schemas/com.wixpress.loyalty.tier.TiersProgramSettings","summary":"programSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTiersProgramSettingsResponse","description":""},"com.wixpress.loyalty.tier.RecalculateAllTiersRequest":{"type":"object","properties":{},"title":"RecalculateAllTiersRequest","description":""},"com.wixpress.loyalty.tier.RecalculateAllTiersResponse":{"type":"object","properties":{},"title":"RecalculateAllTiersResponse","description":""},"com.wixpress.metasite.event.api.MetaSiteSpecialEvent":{"type":"object","properties":{"metaSiteId":{"description":"A meta site id.","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A meta site version. Monotonically increasing.","title":"version","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timestamp":{"description":"A timestamp of the event.","title":"timestamp","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"assets":{"description":"A list of \"assets\" (applications). The same as MetaSiteContext.","maxItems":400,"title":"assets","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.metasite.event.api.Asset"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MetaSiteSpecialEvent","description":"","oneOf":[{"description":"","summary":"payload","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSiteSpecialEvent.payload"}]},"com.wixpress.metasite.event.api.MetaSiteSpecialEvent.payload":{"type":"object","title":"payload","properties":{"siteCreated":{"description":"Emitted on a meta site creation.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteCreated","summary":"siteCreated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteTransferred":{"description":"Emitted on a meta site transfer completion.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteTransferred","summary":"siteTransferred","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteDeleted":{"description":"Emitted on a meta site deletion.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteDeleted","summary":"siteDeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteUndeleted":{"description":"Emitted on a meta site restoration.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteUndeleted","summary":"siteUndeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sitePublished":{"description":"Emitted on the first* publish of the meta site (* switching from unpublished to published state).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SitePublished","summary":"sitePublished","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteUnpublished":{"description":"Emitted on a meta site unpublish.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteUnpublished","summary":"siteUnpublished","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMarkedAsTemplate":{"description":"Emitted when meta site is marked as template.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteMarkedAsTemplate","summary":"siteMarkedAsTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMarkedAsWixSite":{"description":"Emitted when meta site is marked as a WixSite.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteMarkedAsWixSite","summary":"siteMarkedAsWixSite","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceProvisioned":{"description":"Emitted when an application is provisioned (installed).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.ServiceProvisioned","summary":"serviceProvisioned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceRemoved":{"description":"Emitted when an application is removed (uninstalled).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.ServiceRemoved","summary":"serviceRemoved","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteRenamedPayload":{"description":"Emitted when meta site name (URL slug) is changed.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteRenamed","summary":"siteRenamedPayload","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hardDeleted":{"description":"Emitted when meta site was permanently deleted.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteHardDeleted","summary":"hardDeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespaceChanged":{"description":"Emitted on a namespace change.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.NamespaceChanged","summary":"namespaceChanged","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"studioAssigned":{"description":"Emitted when Studio is attached.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.StudioAssigned","summary":"studioAssigned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"studioUnassigned":{"description":"Emitted when Studio is detached.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.StudioUnassigned","summary":"studioUnassigned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.metasite.event.api.Asset":{"type":"object","properties":{"appDefId":{"description":"An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"An instance id. For legacy reasons may be UUID or a string.","maxLength":200,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"state":{"description":"An application state.","title":"state","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.Asset.State","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Asset","description":""},"com.wixpress.metasite.event.api.Asset.State":{"type":"string","description":"","title":"State","enum":["UNKNOWN","ENABLED","DISABLED","PENDING","DEMO"]},"com.wixpress.metasite.event.api.SiteCreated":{"type":"object","properties":{"originTemplateId":{"description":"A template identifier (empty if not created from a template).","maxLength":36,"title":"originTemplateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ownerId":{"description":"An account id of the owner.","format":"GUID","title":"ownerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"context":{"description":"A context in which meta site was created.","title":"context","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteCreatedContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originMetaSiteId":{"description":"A meta site id from which this site was created.\n\nIn case of a creation from a template it's a template id.\nIn case of a site duplication (\"Save As\" in dashboard or duplicate in UM) it's an id of a source site.","format":"GUID","title":"originMetaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteName":{"description":"A meta site name (URL slug).","maxLength":20,"title":"siteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespace":{"description":"A namespace.","title":"namespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteCreated","description":""},"com.wixpress.metasite.event.api.SiteCreatedContext":{"type":"string","description":"","title":"SiteCreatedContext","enum":["OTHER","FROM_TEMPLATE","DUPLICATE_BY_SITE_TRANSFER","DUPLICATE","OLD_SITE_TRANSFER","FLASH"]},"com.wixpress.metasite.event.api.MetaSite.Namespace":{"type":"string","description":"","title":"Namespace","enum":["UNKNOWN_NAMESPACE","WIX","SHOUT_OUT","ALBUMS","WIX_STORES_TEST_DRIVE","HOTELS","CLUBS","ONBOARDING_DRAFT","DEV_SITE","LOGOS","VIDEO_MAKER","PARTNER_DASHBOARD","DEV_CENTER_COMPANY","HTML_DRAFT","SITELESS_BUSINESS","CREATOR_ECONOMY","DASHBOARD_FIRST","ANYWHERE","HEADLESS","ACCOUNT_MASTER_CMS","RISE","BRANDED_FIRST"]},"com.wixpress.metasite.event.api.SiteTransferred":{"type":"object","properties":{"oldOwnerId":{"description":"A previous owner id (user that transfers meta site).","format":"GUID","title":"oldOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newOwnerId":{"description":"A new owner id (user that accepts meta site).","format":"GUID","title":"newOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteTransferred","description":"Site transferred to another user."},"com.wixpress.metasite.event.api.SiteDeleted":{"type":"object","properties":{"deleteContext":{"description":"A deletion context.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext","summary":"deleteContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteDeleted","description":"Soft deletion of the meta site. Could be restored."},"com.wixpress.metasite.event.api.DeleteContext":{"type":"object","properties":{"dateDeleted":{"description":"When the meta site was deleted.","title":"dateDeleted","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteStatus":{"description":"A status.","title":"deleteStatus","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext.DeleteStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteOrigin":{"description":"A reason (flow).","maxLength":255,"title":"deleteOrigin","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initiatorId":{"description":"A service that deleted it.","maxLength":255,"title":"initiatorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteContext","description":""},"com.wixpress.metasite.event.api.DeleteContext.DeleteStatus":{"type":"string","description":"","title":"DeleteStatus","enum":["UNKNOWN","TRASH","DELETED","PENDING_PURGE"]},"com.wixpress.metasite.event.api.SiteUndeleted":{"type":"object","properties":{},"title":"SiteUndeleted","description":"Restoration of the meta site."},"com.wixpress.metasite.event.api.SitePublished":{"type":"object","properties":{},"title":"SitePublished","description":"First publish of a meta site. Or subsequent publish after unpublish."},"com.wixpress.metasite.event.api.SiteUnpublished":{"type":"object","properties":{"urls":{"description":"A list of URLs previously associated with the meta site.","maxLength":4000,"maxItems":10000,"title":"urls","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteUnpublished","description":""},"com.wixpress.metasite.event.api.SiteMarkedAsTemplate":{"type":"object","properties":{},"title":"SiteMarkedAsTemplate","description":""},"com.wixpress.metasite.event.api.SiteMarkedAsWixSite":{"type":"object","properties":{},"title":"SiteMarkedAsWixSite","description":""},"com.wixpress.metasite.event.api.ServiceProvisioned":{"type":"object","properties":{"appDefId":{"description":"Either UUID or EmbeddedServiceType.","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"Not only UUID. Something here could be something weird.","maxLength":36,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originInstanceId":{"description":"An instance id from which this instance is originated.","maxLength":36,"title":"originInstanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A version.","maxLength":50,"title":"version","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceProvisioned","description":""},"com.wixpress.metasite.event.api.ServiceRemoved":{"type":"object","properties":{"appDefId":{"description":"Either UUID or EmbeddedServiceType.","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"Not only UUID. Something here could be something weird.","maxLength":36,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A version.","maxLength":50,"title":"version","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceRemoved","description":""},"com.wixpress.metasite.event.api.SiteRenamed":{"type":"object","properties":{"newSiteName":{"description":"A new meta site name (URL slug).","maxLength":20,"title":"newSiteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oldSiteName":{"description":"A previous meta site name (URL slug).","maxLength":255,"title":"oldSiteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteRenamed","description":"Rename of the site. Meaning, free public url has been changed as well."},"com.wixpress.metasite.event.api.SiteHardDeleted":{"type":"object","properties":{"deleteContext":{"description":"A deletion context.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext","summary":"deleteContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteHardDeleted","description":"Hard deletion of the meta site.\n\nCould not be restored. Therefore it's desirable to cleanup data."},"com.wixpress.metasite.event.api.NamespaceChanged":{"type":"object","properties":{"oldNamespace":{"description":"A previous namespace.","title":"oldNamespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newNamespace":{"description":"A new namespace.","title":"newNamespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NamespaceChanged","description":""},"com.wixpress.metasite.event.api.StudioAssigned":{"type":"object","properties":{},"title":"StudioAssigned","description":"Assigned Studio editor"},"com.wixpress.metasite.event.api.StudioUnassigned":{"type":"object","properties":{},"title":"StudioUnassigned","description":"Unassigned Studio editor"},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","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.","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"}}},"title":"EntityCreatedEvent","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.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":""},"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":"Tier","description":"A tier is a loyalty level that customers are assigned to based on the amount of points they earn.\nRead more about loyalty tiers [here](https://support.wix.com/en/article/about-tiers).","fqdn":"wix.loyalty.v1.tier"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Loyalty Tiers API allows you to create a levels-based program that assigns loyalty accounts to different tiers based on the amount of points they have earned. \n\nWith the Loyalty Tiers API, you can:\n- [Create](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/tiers/create-tier) and [update](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/tiers/update-tier) individual tiers.\n- [Update](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/tiers/update-tiers-program-settings) settings that apply globally to the tiers program. \n\nFor more information about loyalty tiers, see [Adding Tiers to Your Loyalty Program](fallback::https://support.wix.com/en/article/wix-loyalty-program-adding-tiers-to-your-loyalty-program). \n\n## Before you begin \n\nIt's important to note the following points before starting to code:\n- The site must have a [Business VIP Premium Plan](fallback::https://support.wix.com/en/article/business-vip-premium-plan-overview) or a [Scale Premium Plan](fallback::https://support.wix.com/en/article/editor-x-scale-premium-plan-overview) to add tiers.\n- The site must have at least one of these apps: Wix Bookings, Wix Events, Wix Pricing Plans, or Wix Stores.\n >**Note:** Currently, tiers cannot be added to Wix Restaurants loyalty programs.\n- The tiers program `status` must be manually set to `ACTIVE`. Use [Update Tiers Program Settings](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/tiers/update-tiers-program-settings) to update the `status` or enable tiers from a site owner's [dashboard](fallback::https://manage.wix.com/account/site-selector/?actionUrl=https%3A%2F%2Fwww.wix.com%2Fdashboard%2F%7BmetaSiteId%7D%2Floyalty-accounts%2Fmanage%3Ftab%3Dpoints-and-rewards&title=Select+a+Site&primaryButtonText=Select+Site).\n- The Loyalty Tiers API does not handle rules for earning points based on your tier. A site owner may adjust those settings from their dashboard. See [Assign ways to earn to each tier](fallback::https://support.wix.com/en/article/wix-loyalty-program-adding-tiers-to-your-loyalty-program#step-2-assign-ways-to-earn-and-rewards-to-each-tier).\n\n## Terminology \n\n- **Tiers program settings:** Settings that apply globally to the overall tiers program. \n- **Base tier:** A default tier for any loyalty account that is unassigned for not meeting the required points threshold of any other tier. The base tier requires `0` points, has no `tierId`, and is not returned as a tier when [List Tiers](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/tiers/list-tiers) is called. When a tiers program status is `PAUSED` or `DISABLED` all of the loyalty accounts are assigned to the base tier.\n- **Rolling window:** Period of time used to calculate loyalty points for tier assignment. The total points earned and adjusted during this period determine if the account meets a tier's required point threshold. The window is recalculated every 15 minutes or if a new tier event triggers.\n- **Points earned and adjusted:** Tier assignment is based on the total amount of loyalty points earned and adjusted over the period of time in a `rollingWindow`. If an account redeems points during that period, the points that were earned still count towards tier assignment even if that leaves the remaining points balance below the tier's required point threshold. Similarly, if the current points balance for a loyalty account is above a tier's required points threshold, but those points were earned in a time period earlier than the `rollingWindow` then those points are not considered for tier assignment.\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}