{"id":"01e805e0-9791-4d27-a96f-2df9ad94f71c","createdDate":"2024-06-04T10:17:58.196Z","updatedDate":"2024-06-04T10:17:58.196Z","resourceId":"8da3ba9c-760a-4512-ba2a-b3ce717d0df8","api":{"schema":{"object":{"displayName":"Reward Object","description":"A loyalty reward is an object a customer can redeem with loyalty points.\nRedeeming a reward then creates a loyalty coupon that the customer can use.","slug":"reward-object","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward","legacyExamples":[{"title":"Reward","content":"{\n \"reward\": {\n \"id\": \"00000000-0000-0000-0001-000000000000\",\n \"name\": \"Flexible reward\",\n \"requiredPoints\": 10,\n \"active\": true,\n \"type\": \"DISCOUNT_AMOUNT\",\n \"discountAmount\": {\n \"amount\": \"1\",\n \"configsByTier\": [\n {\n \"amount\": \"1\",\n \"costInPoints\": 10\n }\n ]\n },\n \"revision\": \"3\",\n \"createdDate\": \"2024-02-09T09:07:32.797Z\",\n \"updatedDate\": \"2024-03-07T15:47:19.402Z\"\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"methods":[{"summary":"List Rewards","description":"Retrieves a list of rewards.\n\nThe list includes rewards that are currently nonredeemable due to insufficient points held by any customers.","operationId":"com.wixpress.loyalty.reward.LoyaltyRewards.ListRewards","parameters":[{"name":"cursorPaging","in":"query","description":"Pagination options.","required":false,"schema":{"description":"Pagination options.","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.ListRewardsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-rewards","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-rewards","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_REWARDS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.ListRewardsRequest","responseMessage":"com.wixpress.loyalty.reward.ListRewardsResponse"},"legacyExamples":[{"name":"ListRewards","type":"METHOD","content":{"title":"List rewards","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-rewards/v1/rewards' \\\n -H 'Authorization: '","response":"{\n \"rewards\": [\n {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\n \"name\": \"Free shipping\",\n \"requiredPoints\": 20,\n \"active\": true,\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"costInPoints\": 20\n }\n ]\n }\n },\n \"revision\": \"1\",\n \"createdDate\": \"2024-04-18T10:35:41.071Z\",\n \"updatedDate\": \"2024-04-18T10:35:41.071Z\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"total\": 1,\n \"cursors\": {}\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/rewards","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_REWARDS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.ListRewardsRequest","responseMessage":"com.wixpress.loyalty.reward.ListRewardsResponse"},"legacyExamples":[{"name":"ListRewards","type":"METHOD","content":{"title":"List rewards","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-rewards/v1/rewards' \\\n -H 'Authorization: '","response":"{\n \"rewards\": [\n {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\n \"name\": \"Free shipping\",\n \"requiredPoints\": 20,\n \"active\": true,\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"costInPoints\": 20\n }\n ]\n }\n },\n \"revision\": \"1\",\n \"createdDate\": \"2024-04-18T10:35:41.071Z\",\n \"updatedDate\": \"2024-04-18T10:35:41.071Z\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"total\": 1,\n \"cursors\": {}\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"List Rewards","slugifiedName":"list-rewards"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"isAdminMethod":false},{"summary":"Create Reward","description":"Creates a reward that can be redeemed with loyalty points.\n\nWhen a customer [redeems a reward](/coupons/redeem-points-for-coupon), a loyalty coupon is created\nbased on the specifications detailed in either the `discountAmount` or `couponReward` fields. This coupon can\nthen be used by the customer to receive the discount. Note that while the Rewards API uses coupon scopes and specifications,\nno coupon is actually created until a [reward is redeemed](/coupons/redeem-points-for-coupon) with points.\nSee the [Coupons API](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/coupons) for more information about coupons. The `type` of reward\ncannot be updated.\n\nA reward's `active` status defaults to `false`. To make the reward available to customers,\neither set the `active` field to `true` during creation or call [Update Reward](/update-reward)\nto change the status.\n\nTo customize a reward for each [loyalty tier](/tiers), use the `configsByTier` parameter.\nThis allows you to specify the amount of the earned discount, the cost in loyalty points\nto redeem the reward, and the tier to which this configuration applies. Each tier requires its own\n`configsByTier` configuration. To create a reward that is available to loyalty accounts in the base tier,\nleave the `tierId` field empty. See the [Tiers API](/tiers) for more information on tiers.","operationId":"com.wixpress.loyalty.reward.LoyaltyRewards.CreateReward","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.CreateRewardResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-rewards","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-rewards","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateRewardRequest","description":"","properties":{"reward":{"description":"Reward to create.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward","summary":"reward","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["reward","reward.name","reward.typeDetails"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Reward Created","description":"Triggered when a reward is created.","permissions":["LOYALTY.READ_REWARDS"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.reward","serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.reward_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_REWARDS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.CreateRewardRequest","responseMessage":"com.wixpress.loyalty.reward.CreateRewardResponse"},"legacyExamples":[{"name":"CreateReward","type":"METHOD","content":{"title":"Create reward","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-rewards/v1/rewards' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"reward\": {\n \"active\": true,\n \"name\": \"Free shipping\",\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"tierId\": null,\n \"costInPoints\": 20\n }\n ]\n }\n }\n }\n }'","response":"{\n \"reward\": {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\n \"name\": \"Free shipping\",\n \"requiredPoints\": 20,\n \"active\": true,\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"costInPoints\": 20\n }\n ]\n }\n },\n \"revision\": \"1\",\n \"createdDate\": \"2024-04-18T10:35:41.071Z\",\n \"updatedDate\": \"2024-04-18T10:35:41.071Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/rewards","rpcOnly":false,"triggeredEvents":[{"title":"Reward Created","description":"Triggered when a reward is created.","permissions":["LOYALTY.READ_REWARDS"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.reward","serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.reward_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_REWARDS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.CreateRewardRequest","responseMessage":"com.wixpress.loyalty.reward.CreateRewardResponse"},"legacyExamples":[{"name":"CreateReward","type":"METHOD","content":{"title":"Create reward","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-rewards/v1/rewards' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"reward\": {\n \"active\": true,\n \"name\": \"Free shipping\",\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"tierId\": null,\n \"costInPoints\": 20\n }\n ]\n }\n }\n }\n }'","response":"{\n \"reward\": {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\n \"name\": \"Free shipping\",\n \"requiredPoints\": 20,\n \"active\": true,\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"costInPoints\": 20\n }\n ]\n }\n },\n \"revision\": \"1\",\n \"createdDate\": \"2024-04-18T10:35:41.071Z\",\n \"updatedDate\": \"2024-04-18T10:35:41.071Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Create Reward","slugifiedName":"create-reward"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Bulk Create Rewards","description":"Creates multiple rewards.","operationId":"com.wixpress.loyalty.reward.LoyaltyRewards.BulkCreateRewards","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.BulkCreateRewardsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-rewards","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-rewards","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkCreateRewardsRequest","description":"","properties":{"rewards":{"description":"Rewards to create.","minItems":1,"maxItems":10,"title":"rewards","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["rewards","rewards.name","rewards.typeDetails"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Reward Created","description":"Triggered when a reward is created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.reward","serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.reward_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_REWARDS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.BulkCreateRewardsRequest","responseMessage":"com.wixpress.loyalty.reward.BulkCreateRewardsResponse"},"legacyExamples":[{"name":"BulkCreateRewards","type":"METHOD","content":{"title":"Bulk create rewards","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-rewards/bulk/rewards/create' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"rewards\": [\n {\n \"active\": true,\n \"name\": \"Free shipping\",\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"tierId\": null,\n \"costInPoints\": 20\n }\n ]\n }\n }\n }\n ]\n }'","response":"{\n \"results\": [\n {\n \"item\": {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\n \"name\": \"Free shipping\",\n \"requiredPoints\": 20,\n \"active\": true,\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"costInPoints\": 20\n }\n ]\n }\n },\n \"revision\": \"1\",\n \"createdDate\": \"2024-04-18T10:35:41.071Z\",\n \"updatedDate\": \"2024-04-18T10:35:41.071Z\"\n },\n \"itemMetadata\": {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\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/rewards/create","rpcOnly":false,"triggeredEvents":[{"title":"Reward Created","description":"Triggered when a reward is created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.reward","serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.reward_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_REWARDS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.BulkCreateRewardsRequest","responseMessage":"com.wixpress.loyalty.reward.BulkCreateRewardsResponse"},"legacyExamples":[{"name":"BulkCreateRewards","type":"METHOD","content":{"title":"Bulk create rewards","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-rewards/bulk/rewards/create' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"rewards\": [\n {\n \"active\": true,\n \"name\": \"Free shipping\",\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"tierId\": null,\n \"costInPoints\": 20\n }\n ]\n }\n }\n }\n ]\n }'","response":"{\n \"results\": [\n {\n \"item\": {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\n \"name\": \"Free shipping\",\n \"requiredPoints\": 20,\n \"active\": true,\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"costInPoints\": 20\n }\n ]\n }\n },\n \"revision\": \"1\",\n \"createdDate\": \"2024-04-18T10:35:41.071Z\",\n \"updatedDate\": \"2024-04-18T10:35:41.071Z\"\n },\n \"itemMetadata\": {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\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 Rewards","slugifiedName":"bulk-create-rewards"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Get Reward","description":"Retrieves a reward.","operationId":"com.wixpress.loyalty.reward.LoyaltyRewards.GetReward","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the reward to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.GetRewardResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-rewards","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-rewards","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_REWARDS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.GetRewardRequest","responseMessage":"com.wixpress.loyalty.reward.GetRewardResponse"},"legacyExamples":[{"name":"GetReward","type":"METHOD","content":{"title":"Get reward","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-rewards/v1/rewards/46d7bbce-6bb4-4174-ae5a-7f44c19f95ce' \\\n -H 'Authorization: '","response":"{\n \"reward\": {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\n \"name\": \"Free shipping\",\n \"requiredPoints\": 20,\n \"active\": true,\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"costInPoints\": 20\n }\n ]\n }\n },\n \"revision\": \"1\",\n \"createdDate\": \"2024-04-18T10:35:41.071Z\",\n \"updatedDate\": \"2024-04-18T10:35:41.071Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/rewards/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_REWARDS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.GetRewardRequest","responseMessage":"com.wixpress.loyalty.reward.GetRewardResponse"},"legacyExamples":[{"name":"GetReward","type":"METHOD","content":{"title":"Get reward","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-rewards/v1/rewards/46d7bbce-6bb4-4174-ae5a-7f44c19f95ce' \\\n -H 'Authorization: '","response":"{\n \"reward\": {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\n \"name\": \"Free shipping\",\n \"requiredPoints\": 20,\n \"active\": true,\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"costInPoints\": 20\n }\n ]\n }\n },\n \"revision\": \"1\",\n \"createdDate\": \"2024-04-18T10:35:41.071Z\",\n \"updatedDate\": \"2024-04-18T10:35:41.071Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Reward","slugifiedName":"get-reward"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"isAdminMethod":false},{"summary":"Delete Reward","description":"Deletes a reward.","operationId":"com.wixpress.loyalty.reward.LoyaltyRewards.DeleteReward","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the reward to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"revision","in":"query","description":"Revision number, which increments by 1 each time the reward is updated.\n\nTo prevent conflicting changes, the current `revision` must be passed when deleting the reward.","required":false,"schema":{"description":"Revision number, which increments by 1 each time the reward is updated.\n\nTo prevent conflicting changes, the current `revision` must be passed when deleting the reward.","title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.DeleteRewardResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-rewards","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-rewards","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Reward Deleted","description":"Triggered when a reward is deleted.","permissions":["LOYALTY.READ_REWARDS"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.loyalty.v1.reward","serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.reward_deleted","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_REWARDS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.DeleteRewardRequest","responseMessage":"com.wixpress.loyalty.reward.DeleteRewardResponse"},"legacyExamples":[{"name":"DeleteReward","type":"METHOD","content":{"title":"Delete reward","request":"curl -X DELETE \\\n 'https://www.wixapis.com/loyalty-rewards/v1/rewards/46d7bbce-6bb4-4174-ae5a-7f44c19f95ce?revision=1' \\\n -H 'Authorization: '","response":"{\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"delete","path":"/v1/rewards/{id}","rpcOnly":false,"triggeredEvents":[{"title":"Reward Deleted","description":"Triggered when a reward is deleted.","permissions":["LOYALTY.READ_REWARDS"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.loyalty.v1.reward","serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.reward_deleted","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_REWARDS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.DeleteRewardRequest","responseMessage":"com.wixpress.loyalty.reward.DeleteRewardResponse"},"legacyExamples":[{"name":"DeleteReward","type":"METHOD","content":{"title":"Delete reward","request":"curl -X DELETE \\\n 'https://www.wixapis.com/loyalty-rewards/v1/rewards/46d7bbce-6bb4-4174-ae5a-7f44c19f95ce?revision=1' \\\n -H 'Authorization: '","response":"{\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Delete Reward","slugifiedName":"delete-reward"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true},{"summary":"Query Rewards","description":"Retrieves a list of rewards, given the provided paging, filtering, and sorting.\n\nQuery Rewards runs with these defaults, which you can override: `cursorPaging.limit` is `50`.\n\nTo learn about working with _Query_ endpoints, see [API Query Language](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/api-query-language),[Sorting and Paging](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/pagination),and [Field Projection](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/getting-started/field-projection).","operationId":"com.wixpress.loyalty.reward.LoyaltyRewards.QueryRewards","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.QueryRewardsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-rewards","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-rewards","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryRewardsRequest","description":"","properties":{"query":{"description":"Query parameters.","$ref":"#/components/schemas/wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["query"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_REWARDS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.QueryRewardsRequest","responseMessage":"com.wixpress.loyalty.reward.QueryRewardsResponse"},"legacyExamples":[{"name":"QueryRewards","type":"METHOD","content":{"title":"Query rewards","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-rewards/v1/rewards/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"query\": {\n \"filter\": {\"name\": {\"$startsWith\": \"Free\"}}\n }\n }'","response":"{\n \"rewards\": [\n {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\n \"name\": \"Free shipping\",\n \"requiredPoints\": 20,\n \"active\": true,\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"costInPoints\": 20\n }\n ]\n }\n },\n \"revision\": \"1\",\n \"createdDate\": \"2024-04-18T10:35:41.071Z\",\n \"updatedDate\": \"2024-04-18T10:35:41.071Z\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/rewards/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_REWARDS"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.QueryRewardsRequest","responseMessage":"com.wixpress.loyalty.reward.QueryRewardsResponse"},"legacyExamples":[{"name":"QueryRewards","type":"METHOD","content":{"title":"Query rewards","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-rewards/v1/rewards/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"query\": {\n \"filter\": {\"name\": {\"$startsWith\": \"Free\"}}\n }\n }'","response":"{\n \"rewards\": [\n {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\n \"name\": \"Free shipping\",\n \"requiredPoints\": 20,\n \"active\": true,\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"costInPoints\": 20\n }\n ]\n }\n },\n \"revision\": \"1\",\n \"createdDate\": \"2024-04-18T10:35:41.071Z\",\n \"updatedDate\": \"2024-04-18T10:35:41.071Z\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Query Rewards","slugifiedName":"query-rewards"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}],"isAdminMethod":false},{"summary":"Update Reward","description":"Updates a loyalty reward.\n\nUse this endpoint to update details of a reward, such as the name, whether or not a reward is active,\nor the amount of points it costs to redeem. Also use this endpoint to add new tiers that are eligible to redeem a reward.\n\nYou may not change the `type` of a reward. That is set upon creation and cannot be updated.","operationId":"com.wixpress.loyalty.reward.LoyaltyRewards.UpdateReward","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"reward.id","description":"Reward ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.UpdateRewardResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-rewards","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-rewards","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateRewardRequest","description":"","properties":{"reward":{"description":"Reward information to update.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward","summary":"reward","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["reward","reward.id","reward.name","reward.typeDetails","reward.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Reward Updated","description":"Triggered when a reward is updated.","permissions":["LOYALTY.READ_REWARDS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.reward","serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.reward_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_REWARDS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.UpdateRewardRequest","responseMessage":"com.wixpress.loyalty.reward.UpdateRewardResponse"},"legacyExamples":[{"name":"UpdateReward","type":"METHOD","content":{"title":"Update reward","request":"curl -X PUT \\\n 'https://www.wixapis.com/loyalty-rewards/v1/rewards/46d7bbce-6bb4-4174-ae5a-7f44c19f95ce' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"reward\": {\n \"active\": true,\n \"name\": \"Free shipping\",\n \"type\": \"COUPON_REWARD\",\n \"revision\": \"1\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"tierId\": null,\n \"costInPoints\": 20\n },\n {\n \"tierId\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"costInPoints\": 15\n }\n ]\n }\n }\n }\n }'","response":"{\n \"reward\": {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\n \"name\": \"Free shipping\",\n \"requiredPoints\": 20,\n \"active\": true,\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"costInPoints\": 20\n },\n {\n \"tierId\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"costInPoints\": 15\n }\n ]\n }\n },\n \"revision\": \"2\",\n \"createdDate\": \"2024-04-18T10:35:41.071Z\",\n \"updatedDate\": \"2024-04-18T10:35:41.071Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"put","path":"/v1/rewards/{reward.id}","rpcOnly":false,"triggeredEvents":[{"title":"Reward Updated","description":"Triggered when a reward is updated.","permissions":["LOYALTY.READ_REWARDS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.reward","serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.reward_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_REWARDS"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-rewards","serviceArtifactId":"com.wixpress.loyalty.loyalty-rewards","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.reward.UpdateRewardRequest","responseMessage":"com.wixpress.loyalty.reward.UpdateRewardResponse"},"legacyExamples":[{"name":"UpdateReward","type":"METHOD","content":{"title":"Update reward","request":"curl -X PUT \\\n 'https://www.wixapis.com/loyalty-rewards/v1/rewards/46d7bbce-6bb4-4174-ae5a-7f44c19f95ce' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"reward\": {\n \"active\": true,\n \"name\": \"Free shipping\",\n \"type\": \"COUPON_REWARD\",\n \"revision\": \"1\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"tierId\": null,\n \"costInPoints\": 20\n },\n {\n \"tierId\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"costInPoints\": 15\n }\n ]\n }\n }\n }\n }'","response":"{\n \"reward\": {\n \"id\": \"46d7bbce-6bb4-4174-ae5a-7f44c19f95ce\",\n \"name\": \"Free shipping\",\n \"requiredPoints\": 20,\n \"active\": true,\n \"type\": \"COUPON_REWARD\",\n \"couponReward\": {\n \"freeShipping\": {\n \"configsByTier\": [\n {\n \"costInPoints\": 20\n },\n {\n \"tierId\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"costInPoints\": 15\n }\n ]\n }\n },\n \"revision\": \"2\",\n \"createdDate\": \"2024-04-18T10:35:41.071Z\",\n \"updatedDate\": \"2024-04-18T10:35:41.071Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Update Reward","slugifiedName":"update-reward"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"isAdminMethod":true}],"webhooks":[{"summary":"Reward Created","title":"Reward Created","description":"Triggered when a reward is created.","permissions":["LOYALTY.READ_REWARDS"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.reward","serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"eventType":"wix.loyalty.v1.reward_created","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward","contentLink":{"displayName":"Reward Created","slugifiedName":"reward-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]},{"summary":"Reward Updated","title":"Reward Updated","description":"Triggered when a reward is updated.","permissions":["LOYALTY.READ_REWARDS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.reward","serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"eventType":"wix.loyalty.v1.reward_updated","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward","contentLink":{"displayName":"Reward Updated","slugifiedName":"reward-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]},{"summary":"Reward Deleted","title":"Reward Deleted","description":"Triggered when a reward is deleted.","permissions":["LOYALTY.READ_REWARDS"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.loyalty.v1.reward","serviceName":"com.wixpress.loyalty.reward.LoyaltyRewards","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"eventType":"wix.loyalty.v1.reward_deleted","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward","contentLink":{"displayName":"Reward Deleted","slugifiedName":"reward-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Loyalty Rewards API allows you to manage rewards that customers can redeem with their loyalty points.For example, you can create a reward that is redeemed for a coupon for free shipping or for a coupon with a discount that applies to an entire purchase.\n\nWith the Loyalty Rewards API, you can [create](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/rewards/create-reward) and [update](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/rewards/update-reward) the rewards you offer.\n\n## Terminology\n\n- **Discount amount:** A flexible reward type which allows to redeem points and get discount inside a checkout.\n- **Coupon reward:** All other types of rewards other than “discount amount.” The details included here dictate what type of coupon will be created when this reward is redeemed.\n","sourceRepo":"git@github.com:wix-private/app-market.git","path":"proto/docs/introduction.md"}],"components":{"schemas":{"com.wixpress.loyalty.reward.Reward":{"type":"object","properties":{"id":{"description":"Reward ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Reward name.","minLength":1,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"active":{"description":"Whether the reward is active. Default: `FALSE`","title":"active","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Reward type.\n\n+ `DISCOUNT_AMOUNT`: Discount reward. Special flexible reward type used in checkout.\n+ `COUPON_REWARD`: Coupon reward. [Learn more about coupons.](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards)","title":"type","type":"string","$ref":"#/components/schemas/com.wixpress.loyalty.reward.RewardTypeEnum.RewardType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the loyalty reward is updated.\n\nTo prevent conflicting changes, the current `revision` must be passed when updating the loyalty reward.","readOnly":true,"title":"revision","type":"integer","format":"uint64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the reward was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the reward was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Reward","description":"A loyalty reward is an object a customer can redeem with loyalty points.\nRedeeming a reward then creates a loyalty coupon that the customer can use.","oneOf":[{"description":"","summary":"typeDetails","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward.typeDetails"}]},"com.wixpress.loyalty.reward.Reward.typeDetails":{"type":"object","title":"typeDetails","properties":{"discountAmount":{"description":"Discount details.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.DiscountAmount","summary":"discountAmount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"couponReward":{"description":"Coupon details.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.CouponReward","summary":"couponReward","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"com.wixpress.loyalty.reward.RewardTypeEnum.RewardType":{"type":"string","description":"Available reward types.","title":"RewardType","enum":["UNDEFINED","DISCOUNT_AMOUNT","COUPON_REWARD"]},"com.wixpress.loyalty.reward.DiscountAmount":{"type":"object","properties":{"configsByTier":{"description":"Discount details for each tier.","maxItems":21,"title":"configsByTier","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.DiscountAmountConfig"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DiscountAmount","description":""},"com.wixpress.loyalty.reward.DiscountAmountConfig":{"type":"object","properties":{"amount":{"description":"Discount amount. Must be a positive value.","format":"DECIMAL_VALUE","title":"amount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","decimalValue":{"gt":"0","maxScale":2}}},"tierId":{"description":"Tier ID, or empty if config applies to the base tier.","format":"GUID","title":"tierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"costInPoints":{"description":"Amount of points required to redeem the reward.","minimum":1,"maximum":9999999,"title":"costInPoints","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DiscountAmountConfig","description":""},"com.wixpress.loyalty.reward.CouponReward":{"type":"object","properties":{"limitedToOneItem":{"description":"Whether the coupon is limited to one item.","title":"limitedToOneItem","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appliesToSubscriptions":{"description":"Whether the coupon also applies to subscriptions.","title":"appliesToSubscriptions","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"discountedCycleCount":{"description":"Specifies the amount of discounted cycles for a subscription item.\n\nCan only be set when `appliesToSubscriptions` is `true` and `scope.namespace` is `pricingPlans`.\nIf `discountedCycleCount` is empty, the coupon applies to all available cycles.","minimum":1,"maximum":999,"title":"discountedCycleCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CouponReward","description":"","oneOf":[{"description":"","summary":"discountType","$ref":"#/components/schemas/com.wixpress.loyalty.reward.CouponReward.discountType"},{"description":"","summary":"scopeOrMinSubtotal","$ref":"#/components/schemas/com.wixpress.loyalty.reward.CouponReward.scopeOrMinSubtotal"}]},"com.wixpress.loyalty.reward.CouponReward.discountType":{"type":"object","title":"discountType","properties":{"fixedAmount":{"description":"Discount as a fixed amount.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.FixedAmountDiscount","summary":"fixedAmount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"percentage":{"description":"Discount as a percentage.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.PercentageDiscount","summary":"percentage","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"freeShipping":{"description":"Free shipping.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.FreeShippingDiscount","summary":"freeShipping","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.loyalty.reward.CouponReward.scopeOrMinSubtotal":{"type":"object","title":"scopeOrMinSubtotal","properties":{"minimumSubtotal":{"description":"Limit the coupon to carts with a subtotal greater than this number.","title":"minimumSubtotal","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scope":{"description":"Specifies the type of line items this coupon will apply to.\nFor more information, see [valid scope values](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/coupons/coupons/valid-scope-values).","$ref":"#/components/schemas/com.wixpress.loyalty.reward.CouponScope","summary":"scope","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.loyalty.reward.FixedAmountDiscount":{"type":"object","properties":{"configsByTier":{"description":"Discount details for each tier.","minItems":1,"maxItems":21,"title":"configsByTier","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.FixedAmountDiscountConfig"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FixedAmountDiscount","description":""},"com.wixpress.loyalty.reward.FixedAmountDiscountConfig":{"type":"object","properties":{"tierId":{"description":"Tier ID, or empty if config applies to the base tier.","format":"GUID","title":"tierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"costInPoints":{"description":"Amount of points required to redeem the reward.","minimum":1,"maximum":9999999,"title":"costInPoints","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"Discount amount.","title":"amount","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FixedAmountDiscountConfig","description":""},"com.wixpress.loyalty.reward.PercentageDiscount":{"type":"object","properties":{"configsByTier":{"description":"Discount details for each tier.","minItems":1,"maxItems":21,"title":"configsByTier","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.PercentageDiscountConfig"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PercentageDiscount","description":""},"com.wixpress.loyalty.reward.PercentageDiscountConfig":{"type":"object","properties":{"tierId":{"description":"Tier ID, or empty if config applies to the base tier.","format":"GUID","title":"tierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"costInPoints":{"description":"Amount of points required to redeem the reward.","minimum":1,"maximum":9999999,"title":"costInPoints","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"percentage":{"description":"Percentage discount.","title":"percentage","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PercentageDiscountConfig","description":""},"com.wixpress.loyalty.reward.FreeShippingDiscount":{"type":"object","properties":{"configsByTier":{"description":"Discount details for each tier.","minItems":1,"maxItems":21,"title":"configsByTier","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.FreeShippingDiscountConfig"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FreeShippingDiscount","description":""},"com.wixpress.loyalty.reward.FreeShippingDiscountConfig":{"type":"object","properties":{"tierId":{"description":"Tier ID, or empty if config applies to the base tier.","format":"GUID","title":"tierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"costInPoints":{"description":"Amount of points required to redeem the reward.","minimum":1,"maximum":9999999,"title":"costInPoints","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FreeShippingDiscountConfig","description":""},"com.wixpress.loyalty.reward.CouponScope":{"type":"object","properties":{"namespace":{"description":"Scope namespace.\n\nSee [valid scope values](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/coupons/coupons/valid-scope-values) for valid namespaces.","title":"namespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"group":{"description":"Coupon scope's applied group.\n\nSee [valid scope values](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/coupons/coupons/valid-scope-values) for valid groups.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Group","summary":"group","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CouponScope","description":""},"com.wixpress.loyalty.reward.Group":{"type":"object","properties":{"name":{"description":"Name of coupon scope's group.\n\nSee [valid scope values](https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/coupons/coupons/valid-scope-values) for valid groups.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"Entity ID, if the coupon scope is limited to just one item.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Group","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"google.protobuf.UInt64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UInt64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"com.wixpress.loyalty.reward.RewardDisabled":{"type":"object","properties":{},"title":"RewardDisabled","description":""},"com.wixpress.loyalty.reward.CreateRewardRequest":{"type":"object","properties":{"reward":{"description":"Reward to create.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward","summary":"reward","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateRewardRequest","description":""},"com.wixpress.loyalty.reward.CreateRewardResponse":{"type":"object","properties":{"reward":{"description":"Created reward.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward","summary":"reward","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateRewardResponse","description":""},"com.wixpress.loyalty.reward.BulkCreateRewardsRequest":{"type":"object","properties":{"rewards":{"description":"Rewards to create.","minItems":1,"maxItems":10,"title":"rewards","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateRewardsRequest","description":""},"com.wixpress.loyalty.reward.BulkCreateRewardsResponse":{"type":"object","properties":{"results":{"description":"Created rewards.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.BulkRewardResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Total successes and failures of the bulk create rewards action.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateRewardsResponse","description":""},"com.wixpress.loyalty.reward.BulkRewardResult":{"type":"object","properties":{"itemMetadata":{"description":"Item metadata.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Created reward.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRewardResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"com.wixpress.loyalty.reward.GetRewardRequest":{"type":"object","properties":{"id":{"description":"ID of the reward to retrieve.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetRewardRequest","description":""},"com.wixpress.loyalty.reward.GetRewardResponse":{"type":"object","properties":{"reward":{"description":"Retrieved reward.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward","summary":"reward","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetRewardResponse","description":""},"com.wixpress.loyalty.reward.BulkGetRewardsRequest":{"type":"object","properties":{"metaSiteIds":{"description":"Metasite ids.","format":"GUID","maxItems":50,"title":"metaSiteIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkGetRewardsRequest","description":""},"com.wixpress.loyalty.reward.BulkGetRewardsResponse":{"type":"object","properties":{"rewardsInSite":{"description":"Found rewards per site.","title":"rewardsInSite","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.RewardsInSite"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkGetRewardsResponse","description":""},"com.wixpress.loyalty.reward.RewardsInSite":{"type":"object","properties":{"metaSiteId":{"description":"Metasite id.","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rewards":{"description":"Rewards.","title":"rewards","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RewardsInSite","description":""},"com.wixpress.loyalty.reward.QueryRewardsRequest":{"type":"object","properties":{"query":{"description":"Query parameters.","$ref":"#/components/schemas/wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryRewardsRequest","description":""},"wix.common.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","maxItems":5,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.common.CursorQuery.pagingMethod"}]},"wix.common.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"com.wixpress.loyalty.reward.QueryRewardsResponse":{"type":"object","properties":{"rewards":{"description":"Retrieved loyalty rewards.","title":"rewards","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryRewardsResponse","description":""},"wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursor strings that point to the next page, previous page, or both.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wixpress.loyalty.reward.UpdateRewardRequest":{"type":"object","properties":{"reward":{"description":"Reward information to update.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward","summary":"reward","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateRewardRequest","description":""},"com.wixpress.loyalty.reward.UpdateRewardResponse":{"type":"object","properties":{"reward":{"description":"Updated reward.","$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward","summary":"reward","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateRewardResponse","description":""},"com.wixpress.loyalty.reward.DeleteRewardRequest":{"type":"object","properties":{"id":{"description":"ID of the reward to delete.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the reward is updated.\n\nTo prevent conflicting changes, the current `revision` must be passed when deleting the reward.","title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteRewardRequest","description":""},"com.wixpress.loyalty.reward.DeleteRewardResponse":{"type":"object","properties":{},"title":"DeleteRewardResponse","description":""},"com.wixpress.loyalty.reward.ListRewardsRequest":{"type":"object","properties":{"cursorPaging":{"description":"Pagination options.","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListRewardsRequest","description":""},"com.wixpress.loyalty.reward.ListRewardsResponse":{"type":"object","properties":{"rewards":{"description":"Retrieved loyalty rewards.","title":"rewards","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListRewardsResponse","description":""},"wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"com.wixpress.loyalty.reward.ListRewardsInTierRequest":{"type":"object","properties":{"tierId":{"description":"Tier id.","format":"GUID","readOnly":true,"title":"tierId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Pagination options.","$ref":"#/components/schemas/wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListRewardsInTierRequest","description":""},"com.wixpress.loyalty.reward.ListRewardsInTierResponse":{"type":"object","properties":{"rewards":{"description":"Retrieved loyalty rewards.","title":"rewards","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.reward.Reward"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListRewardsInTierResponse","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":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Reward","description":"A loyalty reward is an object a customer can redeem with loyalty points.\nRedeeming a reward then creates a loyalty coupon that the customer can use.","fqdn":"wix.loyalty.v1.reward"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Introduction\n\nThe Loyalty Rewards API allows you to manage rewards that customers can redeem with their loyalty points.For example, you can create a reward that is redeemed for a coupon for free shipping or for a coupon with a discount that applies to an entire purchase.\n\nWith the Loyalty Rewards API, you can [create](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/rewards/create-reward) and [update](fallback::https://www.sbdautomotive.com/ja/wg-cgi/dev.wix.com/api/rest/wix-loyalty-program/rewards/update-reward) the rewards you offer.\n\n## Terminology\n\n- **Discount amount:** A flexible reward type which allows to redeem points and get discount inside a checkout.\n- **Coupon reward:** All other types of rewards other than “discount amount.” The details included here dictate what type of coupon will be created when this reward is redeemed.\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}