{"id":"79fd470f-e86b-4107-b741-99d3add08da4","createdDate":"2024-07-30T10:30:03.689Z","updatedDate":"2024-07-30T10:30:03.689Z","resourceId":"a20d67bc-c307-4daa-a4b3-0244c13447cb","api":{"schema":{"object":{"displayName":"Account Object","description":"A loyalty account stores a customer's loyalty points balance. A site's customers can earn points to their account\nand redeem those points for rewards.","slug":"account-object","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","legacyExamples":[{"title":"LoyaltyAccount","content":"{\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"methods":[{"summary":"List Accounts","description":"Retrieves a list of accounts, given the provided filters.\n\nYou can retrieve selected loyalty accounts with an array of `contactIds` or retrieve a list of all of a site's loyalty accounts\nwith an empty request parameter. Use the `cursorPaging` parameters to limit how many items load at a time.","operationId":"com.wixpress.loyalty.account.LoyaltyAccounts.ListAccounts","parameters":[{"name":"contactIds","in":"query","description":"List of contact IDs. See the [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) to learn more.","required":false,"schema":{"description":"List of contact IDs. See the [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) to learn more.","format":"GUID","maxItems":50,"title":"contactIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"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.account.ListAccountsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-accounts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-accounts","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.ListAccountsRequest","responseMessage":"com.wixpress.loyalty.account.ListAccountsResponse"},"legacyExamples":[{"name":"ListAccounts","type":"METHOD","order":1,"content":{"title":"Get a list of all accounts","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts?cursorPaging.limit=2' \\\n -H 'Authorization: '","response":"{\n \"accounts\": [\n {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivity_date\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n },\n {\n \"id\": \"73618276-35cc-4d21-8380-bdd2fbebf781\",\n \"contactId\": \"fb8f125e-bfc3-4d9a-80c2-215494f24731\",\n \"memberId\": \"ddd5302e-23cf-4fd6-bf6b-461aaae3ab7d\",\n \"points\": {\n \"balance\": 25,\n \"earned\": 30,\n \"redeemed\": 5,\n \"adjusted\": 0\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": null,\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 30\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Aigneis Johnsson\",\n \"picture\": null,\n \"email\": \"aigneis.johnsson@yopmail.com\",\n \"displayName\": \"Aigneis Johnsson\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": null,\n \"total\": 6,\n \"tooManyToCount\": null,\n \"cursors\": {\n \"next\": \"Gh0KDnBvaW50cy5iYWxhbmMlEAEaCREAAAAJJIBhQBorCgxfdXBkYXRlZERhdGUaGyoZChcKCiR0aW1lc3RhbXASCREA4GzcPdl3QiIkYjRkYzAyMzUtMjg2OS00MThjLWJjODQtNDMwNjUxMmMzYjhl\",\n \"prev\": null\n }\n }\n}"}},{"name":"ListAccounts","type":"METHOD","order":2,"content":{"title":"Get a list of accounts, filtered by contact ids","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts?contactIds[]=88615e02-3e8a-4297-8939-5d0a432b322a&contactIds[]=fb8f125e-bfc3-4d9a-80c2-215494f24731' \\\n -H 'Authorization: '","response":"{\n \"accounts\": [\n {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n },\n {\n \"id\": \"73618276-35cc-4d21-8380-bdd2fbebf781\",\n \"contactId\": \"fb8f125e-bfc3-4d9a-80c2-215494f24731\",\n \"memberId\": \"ddd5302e-23cf-4fd6-bf6b-461aaae3ab7d\",\n \"points\": {\n \"balance\": 25,\n \"earned\": 30,\n \"redeemed\": 5,\n \"adjusted\": 0\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": null,\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 30\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Aigneis Johnsson\",\n \"picture\": null,\n \"email\": \"aigneis.johnsson@yopmail.com\",\n \"displayName\": \"Aigneis Johnsson\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": null,\n \"total\": 2,\n \"tooManyToCount\": null,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/accounts","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.ListAccountsRequest","responseMessage":"com.wixpress.loyalty.account.ListAccountsResponse"},"legacyExamples":[{"name":"ListAccounts","type":"METHOD","order":1,"content":{"title":"Get a list of all accounts","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts?cursorPaging.limit=2' \\\n -H 'Authorization: '","response":"{\n \"accounts\": [\n {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivity_date\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n },\n {\n \"id\": \"73618276-35cc-4d21-8380-bdd2fbebf781\",\n \"contactId\": \"fb8f125e-bfc3-4d9a-80c2-215494f24731\",\n \"memberId\": \"ddd5302e-23cf-4fd6-bf6b-461aaae3ab7d\",\n \"points\": {\n \"balance\": 25,\n \"earned\": 30,\n \"redeemed\": 5,\n \"adjusted\": 0\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": null,\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 30\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Aigneis Johnsson\",\n \"picture\": null,\n \"email\": \"aigneis.johnsson@yopmail.com\",\n \"displayName\": \"Aigneis Johnsson\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": null,\n \"total\": 6,\n \"tooManyToCount\": null,\n \"cursors\": {\n \"next\": \"Gh0KDnBvaW50cy5iYWxhbmMlEAEaCREAAAAJJIBhQBorCgxfdXBkYXRlZERhdGUaGyoZChcKCiR0aW1lc3RhbXASCREA4GzcPdl3QiIkYjRkYzAyMzUtMjg2OS00MThjLWJjODQtNDMwNjUxMmMzYjhl\",\n \"prev\": null\n }\n }\n}"}},{"name":"ListAccounts","type":"METHOD","order":2,"content":{"title":"Get a list of accounts, filtered by contact ids","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts?contactIds[]=88615e02-3e8a-4297-8939-5d0a432b322a&contactIds[]=fb8f125e-bfc3-4d9a-80c2-215494f24731' \\\n -H 'Authorization: '","response":"{\n \"accounts\": [\n {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n },\n {\n \"id\": \"73618276-35cc-4d21-8380-bdd2fbebf781\",\n \"contactId\": \"fb8f125e-bfc3-4d9a-80c2-215494f24731\",\n \"memberId\": \"ddd5302e-23cf-4fd6-bf6b-461aaae3ab7d\",\n \"points\": {\n \"balance\": 25,\n \"earned\": 30,\n \"redeemed\": 5,\n \"adjusted\": 0\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": null,\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 30\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Aigneis Johnsson\",\n \"picture\": null,\n \"email\": \"aigneis.johnsson@yopmail.com\",\n \"displayName\": \"Aigneis Johnsson\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": null,\n \"total\": 2,\n \"tooManyToCount\": null,\n \"cursors\": {\n \"next\": null,\n \"prev\": null\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"List Accounts","slugifiedName":"list-accounts"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]},{"summary":"Create Account","description":"Creates a loyalty account for one of a site's contacts.\n\nTo create a new loyalty account, the customer must first be a site contact with a contact ID. See the Contacts API to\n[learn more about a site's contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object). The site must also\nhave an active loyalty program before loyalty accounts can be created. See the activate loyalty program endpoint\n[to activate a site's loyalty program](https://dev.wix.com/api/rest/wix-loyalty-program/program/activate-loyalty-program).","operationId":"com.wixpress.loyalty.account.LoyaltyAccounts.CreateAccount","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.CreateAccountResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-accounts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-accounts","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateAccountRequest","description":"","properties":{"contactId":{"description":"Contact ID for a Wix site contact. See the Contacts API to\n[learn more about a site's contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object).","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["contactId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Account Created","description":"Triggered when a loyalty account is created.","permissions":["LOYALTY.READ_ACCOUNTS"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.account_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.CreateAccountRequest","responseMessage":"com.wixpress.loyalty.account.CreateAccountResponse"},"legacyExamples":[{"name":"CreateAccount","type":"METHOD","content":{"title":"Create an account for the contact","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\"\n }'","response":"{\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"3c7267de-204d-4f6c-b5a5-5d060bc3b21c\",\n \"points\": {\n \"balance\": 0,\n \"earned\": 0,\n \"redeemed\": 0,\n \"adjusted\": 0\n },\n \"rewardAvailable\": false,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-06T14:33:19.114Z\",\n \"revision\": \"1\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/accounts","rpcOnly":false,"triggeredEvents":[{"title":"Account Created","description":"Triggered when a loyalty account is created.","permissions":["LOYALTY.READ_ACCOUNTS"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.account_created","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.CreateAccountRequest","responseMessage":"com.wixpress.loyalty.account.CreateAccountResponse"},"legacyExamples":[{"name":"CreateAccount","type":"METHOD","content":{"title":"Create an account for the contact","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\"\n }'","response":"{\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"3c7267de-204d-4f6c-b5a5-5d060bc3b21c\",\n \"points\": {\n \"balance\": 0,\n \"earned\": 0,\n \"redeemed\": 0,\n \"adjusted\": 0\n },\n \"rewardAvailable\": false,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-06T14:33:19.114Z\",\n \"revision\": \"1\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Create Account","slugifiedName":"create-account"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}]},{"summary":"Earn Points","description":"Adds points to a loyalty account.\n\nOnly a positive amount can be added using the earn points endpoint. To adjust an account's balance\nfor a negative amount, use [Adjust Points](https://dev.wix.com/api/rest/wix-loyalty-program/accounts/adjust-points).","operationId":"com.wixpress.loyalty.account.LoyaltyAccounts.EarnPoints","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"accountId","description":"Loyalty account ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.EarnPointsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-accounts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-accounts","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"EarnPointsRequest","description":"","properties":{"amount":{"description":"Amount of points to earn. Must be a positive, whole number.\n\nMin: `1`\n\nMax: `9999999`","minimum":1,"maximum":9999999,"title":"amount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of how the points were earned.\n\nMax: 100 characters","minLength":1,"maxLength":100,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the app that initiated the transaction.\n\nIf points were earned manually, then the `appId` is the Loyalty app's\n`wixAppId` of `553c79f3-5625-4f38-b14b-ef7c0d1e87df`. If points were earned in an automatic event,\nthen the `appId` is from that automation's `sourceAppId`.","minLength":1,"maxLength":100,"title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"idempotencyKey":{"description":"Unique string identifier generated by the app. Wix uses this identifier to recognize subsequent retries of the same request.\n\nPlease use `GUID` format.","minLength":1,"maxLength":256,"title":"idempotencyKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activityType":{"description":"Activity type.\n\nIf points were earned through automation it should be set to trigger key.","maxLength":100,"title":"activityType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"orderId":{"description":"Order id which was source of this transaction.","maxLength":512,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["accountId","appId","idempotencyKey"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Account Updated","description":"Triggered when a loyalty account is updated, including when points are adjusted, earned, or redeemed.","permissions":["LOYALTY.READ_ACCOUNTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.account_updated","sourceRepo":"git@github.com:wix-private/app-market.git"},{"title":"Account Points Updated","description":"Triggered when the points of a loyalty account are adjusted, earned, or redeemed.","permissions":["LOYALTY.READ_ACCOUNTS"],"payload":{"schemaName":"com.wixpress.loyalty.account.PointsUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"points_updated","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.account_points_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.EarnPointsRequest","responseMessage":"com.wixpress.loyalty.account.EarnPointsResponse"},"legacyExamples":[{"name":"EarnPoints","type":"METHOD","content":{"title":"Add points to account","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/e6f39a5b-a6d0-4556-b889-0cf09d8a84f7/earn-points' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"accountId\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"amount\": 10,\n \"description\": \"For subscribing to the newsletter\",\n \"appId\": \"db9c3016-ff93-4105-bdef-ff852f3c74c0\",\n \"idempotencyKey\": \"baa05589-20d1-45db-ba29-99920bccf37e\"\n }'","response":"{\n \"transactionId\": \"262c8eb0-123e-4117-9fe6-4973a3551688\",\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 10,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 0\n },\n \"rewardAvailable\": false,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:26:56.417Z\",\n \"revision\": \"2\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updated_date\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/accounts/{accountId}/earn-points","rpcOnly":false,"triggeredEvents":[{"title":"Account Updated","description":"Triggered when a loyalty account is updated, including when points are adjusted, earned, or redeemed.","permissions":["LOYALTY.READ_ACCOUNTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.account_updated","sourceRepo":"git@github.com:wix-private/app-market.git"},{"title":"Account Points Updated","description":"Triggered when the points of a loyalty account are adjusted, earned, or redeemed.","permissions":["LOYALTY.READ_ACCOUNTS"],"payload":{"schemaName":"com.wixpress.loyalty.account.PointsUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"points_updated","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.account_points_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.EarnPointsRequest","responseMessage":"com.wixpress.loyalty.account.EarnPointsResponse"},"legacyExamples":[{"name":"EarnPoints","type":"METHOD","content":{"title":"Add points to account","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/e6f39a5b-a6d0-4556-b889-0cf09d8a84f7/earn-points' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"accountId\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"amount\": 10,\n \"description\": \"For subscribing to the newsletter\",\n \"appId\": \"db9c3016-ff93-4105-bdef-ff852f3c74c0\",\n \"idempotencyKey\": \"baa05589-20d1-45db-ba29-99920bccf37e\"\n }'","response":"{\n \"transactionId\": \"262c8eb0-123e-4117-9fe6-4973a3551688\",\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 10,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 0\n },\n \"rewardAvailable\": false,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:26:56.417Z\",\n \"revision\": \"2\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updated_date\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Earn Points","slugifiedName":"earn-points"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}]},{"summary":"Adjust Points","description":"Adjusts the point balance of a loyalty account.\n\nYou can adjust the balance in two ways:\n- `balance` allows you to set the total points balance to this new amount.\n- `amount` allows you to adjust the points balance by this amount. This amount can be a positive number to increase the points balance or a negative number to decrease the balance.\n\nAn account may not be adjusted to result in a negative balance. If you pass an integer in both the `balance` and the `amount` parameters then the `balance` adjustment takes effect and the\n`amount` adjustment is ignored.","operationId":"com.wixpress.loyalty.account.LoyaltyAccounts.AdjustPoints","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"accountId","description":"Loyalty account ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.AdjustPointsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-accounts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-accounts","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AdjustPointsRequest","description":"","properties":{"description":{"description":"Description to explain the reason for the points adjustment.","minLength":1,"maxLength":100,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Each time the loyalty account is updated, `revision` increments by 1.\n\nThe current `revision` must be passed when adjusting points in the loyalty account. This\nensures you're working with the latest version of the loyalty account and prevents unintended overwrites.","minimum":1,"title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"oneOf":[{"description":"","summary":"type","$ref":"#/components/schemas/com.wixpress.loyalty.account.AdjustPointsRequest.type"}],"required":["accountId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Account Updated","description":"Triggered when a loyalty account is updated, including when points are adjusted, earned, or redeemed.","permissions":["LOYALTY.READ_ACCOUNTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.account_updated","sourceRepo":"git@github.com:wix-private/app-market.git"},{"title":"Account Points Updated","description":"Triggered when the points of a loyalty account are adjusted, earned, or redeemed.","permissions":["LOYALTY.READ_ACCOUNTS"],"payload":{"schemaName":"com.wixpress.loyalty.account.PointsUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"points_updated","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.account_points_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.AdjustPointsRequest","responseMessage":"com.wixpress.loyalty.account.AdjustPointsResponse"},"legacyExamples":[{"name":"AdjustPoints","type":"METHOD","content":{"title":"Adjust account balance","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/e6f39a5b-a6d0-4556-b889-0cf09d8a84f7/adjust-points' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"accountId\": \"01e34b81-4e48-43e4-b178-c84f3b968574\",\n \"description\": \"Sync from external program\",\n \"balance\": 15,\n \"revision\": \"3\"\n }'","response":"{\n \"transactionId\": \"9d29cf95-fd2c-4db4-8f4d-2d65c52cacb9\",\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/accounts/{accountId}/adjust-points","rpcOnly":false,"triggeredEvents":[{"title":"Account Updated","description":"Triggered when a loyalty account is updated, including when points are adjusted, earned, or redeemed.","permissions":["LOYALTY.READ_ACCOUNTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.account_updated","sourceRepo":"git@github.com:wix-private/app-market.git"},{"title":"Account Points Updated","description":"Triggered when the points of a loyalty account are adjusted, earned, or redeemed.","permissions":["LOYALTY.READ_ACCOUNTS"],"payload":{"schemaName":"com.wixpress.loyalty.account.PointsUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"points_updated","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.account_points_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.AdjustPointsRequest","responseMessage":"com.wixpress.loyalty.account.AdjustPointsResponse"},"legacyExamples":[{"name":"AdjustPoints","type":"METHOD","content":{"title":"Adjust account balance","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/e6f39a5b-a6d0-4556-b889-0cf09d8a84f7/adjust-points' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"accountId\": \"01e34b81-4e48-43e4-b178-c84f3b968574\",\n \"description\": \"Sync from external program\",\n \"balance\": 15,\n \"revision\": \"3\"\n }'","response":"{\n \"transactionId\": \"9d29cf95-fd2c-4db4-8f4d-2d65c52cacb9\",\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Adjust Points","slugifiedName":"adjust-points"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}]},{"summary":"Get Account","description":"Retrieves an account using the loyalty account ID.\n\nYou can also retrieve an account using a secondary ID, such as a contact ID or a member ID by using\nthe [Get Account by Secondary ID endpoint](https://dev.wix.com/api/rest/wix-loyalty-program/accounts/get-account-by-secondary-id).","operationId":"com.wixpress.loyalty.account.LoyaltyAccounts.GetAccount","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the account to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.GetAccountResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-accounts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-accounts","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.GetAccountRequest","responseMessage":"com.wixpress.loyalty.account.GetAccountResponse"},"legacyExamples":[{"name":"GetAccount","type":"METHOD","content":{"title":"Get an account","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/e6f39a5b-a6d0-4556-b889-0cf09d8a84f7' \\\n -H 'Authorization: '","response":"{\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/accounts/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.GetAccountRequest","responseMessage":"com.wixpress.loyalty.account.GetAccountResponse"},"legacyExamples":[{"name":"GetAccount","type":"METHOD","content":{"title":"Get an account","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/e6f39a5b-a6d0-4556-b889-0cf09d8a84f7' \\\n -H 'Authorization: '","response":"{\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Account","slugifiedName":"get-account"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]},{"summary":"Get Program Totals","description":"Retrieves the total amount of points earned, redeemed, and adjusted for the entire loyalty program.\n\nThe `balance` is the current total of points outstanding, while the `earned`, `adjusted`, and `redeemed` amounts\nare the historically accumulated amounts. The totals include the amounts for all loyalty accounts.","operationId":"com.wixpress.loyalty.account.LoyaltyAccounts.GetProgramTotals","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.GetProgramTotalsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-accounts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-accounts","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.GetProgramTotalsRequest","responseMessage":"com.wixpress.loyalty.account.GetProgramTotalsResponse"},"legacyExamples":[{"name":"GetProgramTotals","type":"METHOD","content":{"title":"Get the program totals","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/program-totals' \\\n -H 'Authorization: '","response":"{\n \"points\": {\n \"balance\": 165,\n \"earned\": 136,\n \"redeemed\": 0,\n \"adjusted\": 29,\n \"expired\": 0\n },\n \"tierTotals\": [\n {\n \"numberOfAccounts\": 5\n },\n {\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"numberOfAccounts\": 3\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/accounts/program-totals","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.GetProgramTotalsRequest","responseMessage":"com.wixpress.loyalty.account.GetProgramTotalsResponse"},"legacyExamples":[{"name":"GetProgramTotals","type":"METHOD","content":{"title":"Get the program totals","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/program-totals' \\\n -H 'Authorization: '","response":"{\n \"points\": {\n \"balance\": 165,\n \"earned\": 136,\n \"redeemed\": 0,\n \"adjusted\": 29,\n \"expired\": 0\n },\n \"tierTotals\": [\n {\n \"numberOfAccounts\": 5\n },\n {\n \"id\": \"acddc0e0-5e27-4a1b-a52d-b3785ac258cb\",\n \"numberOfAccounts\": 3\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Program Totals","slugifiedName":"get-program-totals"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]},{"summary":"Get Current Member Account","description":"Retrieves the currently logged-in member's account.","operationId":"com.wixpress.loyalty.account.LoyaltyAccounts.GetCurrentMemberAccount","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.GetCurrentMemberAccountResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-accounts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-accounts","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_OWN_ACCOUNT"],"applicableIdentities":["APP","MEMBER"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.GetCurrentMemberAccountRequest","responseMessage":"com.wixpress.loyalty.account.GetCurrentMemberAccountResponse"},"legacyExamples":[{"name":"GetCurrentMemberAccount","type":"METHOD","content":{"title":"Get currently logged-in member account","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/my-account' \\\n -H 'Authorization: '","response":"{\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/accounts/my-account","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_OWN_ACCOUNT"],"applicableIdentities":["APP","MEMBER"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.GetCurrentMemberAccountRequest","responseMessage":"com.wixpress.loyalty.account.GetCurrentMemberAccountResponse"},"legacyExamples":[{"name":"GetCurrentMemberAccount","type":"METHOD","content":{"title":"Get currently logged-in member account","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/my-account' \\\n -H 'Authorization: '","response":"{\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Current Member Account","slugifiedName":"get-current-member-account"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]},{"summary":"Get Account By Secondary Id","description":"Retrieves the account belonging to the specified contact or member.\n\nThis endpoint retrieves loyalty accounts using either a customer's contact ID or member ID. Your app can also retrieve an account\nusing the loyalty account ID by using the [Get Account endpoint](https://dev.wix.com/api/rest/wix-loyalty-program/accounts/get-account-by-secondary-id).","operationId":"com.wixpress.loyalty.account.LoyaltyAccounts.GetAccountBySecondaryId","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.GetAccountBySecondaryIdResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-accounts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-accounts","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.GetAccountBySecondaryIdRequest","responseMessage":"com.wixpress.loyalty.account.GetAccountBySecondaryIdResponse"},"legacyExamples":[{"name":"GetAccountBySecondaryId","type":"METHOD","order":1,"content":{"title":"Get account by contactId","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/fetch-by?contactId=88615e02-3e8a-4297-8939-5d0a432b322a' \\\n -H 'Authorization: '","response":"{\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}"}},{"name":"GetAccountBySecondaryId","type":"METHOD","order":2,"content":{"title":"Get account by memberId","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/fetch-by?memberId=a517751b-a1ca-4423-8d91-aaf8f5b34215' \\\n -H 'Authorization: '","response":"{\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/accounts/fetch-by","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.GetAccountBySecondaryIdRequest","responseMessage":"com.wixpress.loyalty.account.GetAccountBySecondaryIdResponse"},"legacyExamples":[{"name":"GetAccountBySecondaryId","type":"METHOD","order":1,"content":{"title":"Get account by contactId","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/fetch-by?contactId=88615e02-3e8a-4297-8939-5d0a432b322a' \\\n -H 'Authorization: '","response":"{\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}"}},{"name":"GetAccountBySecondaryId","type":"METHOD","order":2,"content":{"title":"Get account by memberId","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/fetch-by?memberId=a517751b-a1ca-4423-8d91-aaf8f5b34215' \\\n -H 'Authorization: '","response":"{\n \"account\": {\n \"id\": \"e6f39a5b-a6d0-4556-b889-0cf09d8a84f7\",\n \"contactId\": \"88615e02-3e8a-4297-8939-5d0a432b322a\",\n \"memberId\": \"a517751b-a1ca-4423-8d91-aaf8f5b34215\",\n \"points\": {\n \"balance\": 15,\n \"earned\": 10,\n \"redeemed\": 0,\n \"adjusted\": 5\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2021-12-06T14:33:19.114Z\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"revision\": \"4\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2022-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Account By Secondary Id","slugifiedName":"get-account-by-secondary-id"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]},{"summary":"Search Accounts","description":"Retrieves a list of accounts, given the provided filters and search capabilities.\nSearch is executed on the account's name and email values.","operationId":"com.wixpress.loyalty.account.LoyaltyAccounts.SearchAccounts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.SearchAccountsResponse","description":"Accounts found through provided search capabilities, along with paging and aggregation data of the results."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-accounts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-accounts","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SearchAccountsRequest","description":"Options to use when search for loyalty accounts.","properties":{"search":{"description":"Search options.","$ref":"#/components/schemas/wix.common.CursorSearch","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.SearchAccountsRequest","responseMessage":"com.wixpress.loyalty.account.SearchAccountsResponse"},"legacyExamples":[{"name":"SearchAccounts","type":"METHOD","content":{"title":"Search accounts, given the provided filters","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/search' \\\n -H 'Authorization: ' \\\n --data-raw '{\n \"search\": {\n \"search\": {\"expression\": \"John\"},\n \"cursor_paging\": {\"limit\": 2}\n }\n }'","response":"{\n \"accounts\": [\n {\n \"id\": \"0d1ce314-084a-4edd-a0c7-8a885c6248ba\",\n \"contactId\": \"f96d2d30-a267-41e8-832c-615fae1bfee3\",\n \"memberId\": null,\n \"points\": {\n \"balance\": 573,\n \"earned\": 0,\n \"redeemed\": 0,\n \"adjusted\": 0\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2023-10-06T11:09:01.443Z\",\n \"updatedDate\": \"2023-10-19T22:07:15.618Z\",\n \"revision\": \"14\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2023-10-10T15:34:44.864Z\",\n \"contact\": {\n \"id\": \"f96d2d30-a267-41e8-832c-615fae1bfee3\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2024-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n },\n {\n \"id\": \"19b378db-896d-480d-a75e-cb4e5b77bf26\",\n \"contactId\": \"63f477d4-a278-4a1d-8d4c-2a2786970f90\",\n \"memberId\": null,\n \"points\": {\n \"balance\": 474,\n \"earned\": 0,\n \"redeemed\": 0,\n \"adjusted\": 0\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2023-10-05T14:08:44.221Z\",\n \"updatedDate\": \"2023-10-19T22:06:23.608Z\",\n \"revision\": \"20\",\n \"tier\": {\n \"id\": null,\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 30\n },\n \"lastActivityDate\": \"2023-10-10T15:33:34.088Z\",\n \"contact\": {\n \"id\": \"63f477d4-a278-4a1d-8d4c-2a2786970f90\",\n \"name\": \"Aigneis Johnsson\",\n \"picture\": null,\n \"email\": \"aigneis.johnsson@yopmail.com\",\n \"displayName\": \"Aigneis Johnsson\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2024-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": \"19b378db-896d-480d-a75e-cb4e5b77bf26,1.0\",\n \"prev\": null\n },\n \"hasNext\": true\n },\n \"aggregationData\": null\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/accounts/search","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.SearchAccountsRequest","responseMessage":"com.wixpress.loyalty.account.SearchAccountsResponse"},"legacyExamples":[{"name":"SearchAccounts","type":"METHOD","content":{"title":"Search accounts, given the provided filters","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/search' \\\n -H 'Authorization: ' \\\n --data-raw '{\n \"search\": {\n \"search\": {\"expression\": \"John\"},\n \"cursor_paging\": {\"limit\": 2}\n }\n }'","response":"{\n \"accounts\": [\n {\n \"id\": \"0d1ce314-084a-4edd-a0c7-8a885c6248ba\",\n \"contactId\": \"f96d2d30-a267-41e8-832c-615fae1bfee3\",\n \"memberId\": null,\n \"points\": {\n \"balance\": 573,\n \"earned\": 0,\n \"redeemed\": 0,\n \"adjusted\": 0\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2023-10-06T11:09:01.443Z\",\n \"updatedDate\": \"2023-10-19T22:07:15.618Z\",\n \"revision\": \"14\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2023-10-10T15:34:44.864Z\",\n \"contact\": {\n \"id\": \"f96d2d30-a267-41e8-832c-615fae1bfee3\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2024-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n },\n {\n \"id\": \"19b378db-896d-480d-a75e-cb4e5b77bf26\",\n \"contactId\": \"63f477d4-a278-4a1d-8d4c-2a2786970f90\",\n \"memberId\": null,\n \"points\": {\n \"balance\": 474,\n \"earned\": 0,\n \"redeemed\": 0,\n \"adjusted\": 0\n },\n \"rewardAvailable\": true,\n \"createdDate\": \"2023-10-05T14:08:44.221Z\",\n \"updatedDate\": \"2023-10-19T22:06:23.608Z\",\n \"revision\": \"20\",\n \"tier\": {\n \"id\": null,\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 30\n },\n \"lastActivityDate\": \"2023-10-10T15:33:34.088Z\",\n \"contact\": {\n \"id\": \"63f477d4-a278-4a1d-8d4c-2a2786970f90\",\n \"name\": \"Aigneis Johnsson\",\n \"picture\": null,\n \"email\": \"aigneis.johnsson@yopmail.com\",\n \"displayName\": \"Aigneis Johnsson\"\n },\n \"points_expiration\": {\n \"expiration_date\": \"2024-05-07T07:30:23.749Z\",\n \"expiring_points_amount\": 5\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": \"19b378db-896d-480d-a75e-cb4e5b77bf26,1.0\",\n \"prev\": null\n },\n \"hasNext\": true\n },\n \"aggregationData\": null\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Search Accounts","slugifiedName":"search-accounts"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]},{"summary":"Count Accounts","description":"Retrieves the count of found accounts, given the provided filters and search capabilities.\n\nThis endpoint can help find the total count of accounts when used alongside [Search Accounts](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/search-accounts).","operationId":"com.wixpress.loyalty.account.LoyaltyAccounts.CountAccounts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.CountAccountsResponse","description":"Count of accounts found for given search query"}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-accounts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-accounts","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CountAccountsRequest","description":"Options to use when looking up count of loyalty accounts.","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.CountAccountsRequest","responseMessage":"com.wixpress.loyalty.account.CountAccountsResponse"},"legacyExamples":[{"name":"CountAccounts","type":"METHOD","content":{"title":"Count accounts, given the provided filters","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/count' \\\n -H 'Authorization: ' \\\n --data-raw '{\n \"search\": {\"expression\": \"John\"},\n \"filter\": {\"points.balance\": {\"$gte\": 50}}\n }'","response":"{\n \"count\": 2\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/accounts/count","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.CountAccountsRequest","responseMessage":"com.wixpress.loyalty.account.CountAccountsResponse"},"legacyExamples":[{"name":"CountAccounts","type":"METHOD","content":{"title":"Count accounts, given the provided filters","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-accounts/v1/accounts/count' \\\n -H 'Authorization: ' \\\n --data-raw '{\n \"search\": {\"expression\": \"John\"},\n \"filter\": {\"points.balance\": {\"$gte\": 50}}\n }'","response":"{\n \"count\": 2\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Count Accounts","slugifiedName":"count-accounts"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]},{"summary":"Bulk Adjust Points","description":"Updates points balance of multiple accounts.\nDepending on the BulkAdjustPointsRequest.type:\namount - provided amount of points is appended to the accounts balance\nbalance - accounts balance is set to the provided amount\n\nReturns id of the asyncInfra job that takes care of the points adjustment.","operationId":"com.wixpress.loyalty.account.LoyaltyAccounts.BulkAdjustPoints","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.BulkAdjustPointsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-accounts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-accounts","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkAdjustPointsRequest","description":"","properties":{"search":{"description":"","$ref":"#/components/schemas/wix.common.CursorSearch","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"oneOf":[{"description":"","summary":"type","$ref":"#/components/schemas/com.wixpress.loyalty.account.BulkAdjustPointsRequest.type"}]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.BulkAdjustPointsRequest","responseMessage":"com.wixpress.loyalty.account.BulkAdjustPointsResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/accounts/bulk-adjust","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_ACCOUNTS"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-accounts","serviceArtifactId":"com.wixpress.loyalty.loyalty-accounts","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.account.BulkAdjustPointsRequest","responseMessage":"com.wixpress.loyalty.account.BulkAdjustPointsResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Bulk Adjust Points","slugifiedName":"bulk-adjust-points"},"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}]}],"webhooks":[{"summary":"Account Reward Availability Updated","title":"Account Reward Availability Updated","description":"Triggered when rewardAvailable field is changed on Account.","permissions":["LOYALTY.READ_ACCOUNTS"],"payload":{"schemaName":"com.wixpress.loyalty.account.RewardAvailabilityUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"reward_availability_updated","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"eventType":"wix.loyalty.v1.account_reward_availability_updated","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.loyalty.account.RewardAvailabilityUpdated","contentLink":{"displayName":"Account Reward Availability Updated","slugifiedName":"account-reward-availability-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":"Account Struct","title":"Account Struct","description":"","permissions":[],"payload":{"schemaName":"google.protobuf.Struct"},"exposure":"PUBLIC","maturity":"GA","slug":"struct","eventTopic":"actiontriggers.ReportEvent","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"NOT_DOMAIN_EVENT","externalPermissionScopes":[],"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/google.protobuf.Struct","contentLink":{"displayName":"Account Struct","slugifiedName":"account-struct"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Loyalty Account Created","title":"Account Created","description":"Triggered when a loyalty account is created.","permissions":["LOYALTY.READ_ACCOUNTS"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","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.account_created","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","contentLink":{"displayName":"Loyalty Account Created","slugifiedName":"loyalty-account-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"},{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"}]},{"summary":"Loyalty Account Updated","title":"Account Updated","description":"Triggered when a loyalty account is updated, including when points are adjusted, earned, or redeemed.","permissions":["LOYALTY.READ_ACCOUNTS"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","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.account_updated","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","contentLink":{"displayName":"Loyalty Account Updated","slugifiedName":"loyalty-account-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":"Points Updated","title":"Account Points Updated","description":"Triggered when the points of a loyalty account are adjusted, earned, or redeemed.","permissions":["LOYALTY.READ_ACCOUNTS"],"payload":{"schemaName":"com.wixpress.loyalty.account.PointsUpdated"},"exposure":"PUBLIC","maturity":"GA","slug":"points_updated","eventTopic":"domain_events_wix.loyalty.v1.account","serviceName":"com.wixpress.loyalty.account.LoyaltyAccounts","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"eventType":"wix.loyalty.v1.account_points_updated","legacyExamples":[{"name":"PointsUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"48b171b8-e2c1-46da-92ff-5ce4b173c751\",\n \"entityFqdn\": \"wix.loyalty.v1.account\",\n \"slug\": \"points_updated\",\n \"entityId\": \"2bdbac7d-b121-4191-84bf-a359b20bc8c6\",\n \"actionEvent\": {\n \"body\": {\n \"account\": {\n \"rewardAvailable\": false,\n \"revision\": \"3\",\n \"points\": {\n \"balance\": 1,\n \"earned\": 0,\n \"adjusted\": 1,\n \"redeemed\": 0\n },\n \"id\": \"fe0ca230-61a6-4ebf-9199-9c0d238619aa\",\n \"contactId\": \"87bbd811-f753-4de4-994d-69b24d22cb56\",\n \"memberId\": \"87bbd811-f753-4de4-994d-69b24d22cb56\",\n \"updatedDate\": \"2021-12-29T14:06:50.092Z\",\n \"createdDate\": \"2021-12-29T13:55:32.505Z\",\n \"tier\": {\n \"id\": \"1415f107-640c-4e04-870f-149cdd562093\",\n \"updatedDate\": \"2021-12-07T07:30:23.749Z\",\n \"recalculationDate\": null,\n \"points\": 15\n },\n \"lastActivityDate\": \"2021-12-07T07:30:23.749Z\",\n \"contact\": {\n \"id\": \"7728152f-7deb-45f8-913f-7fdff4abbebe\",\n \"name\": \"Johna Linskey\",\n \"picture\": null,\n \"email\": \"johna.linskey@yopmail.com\",\n \"displayName\": \"Johna Linskey\"\n }\n }\n }\n },\n \"eventTime\": \"2021-12-29T14:06:50.106622Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.loyalty.account.PointsUpdated","contentLink":{"displayName":"Points Updated","slugifiedName":"points-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"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Loyalty Accounts\n\nThe loyalty accounts API allows a site owner to create and manage its customers' loyalty accounts. The loyalty accounts\nmaintain a customer's balance of loyalty points. \n\nWith the loyalty accounts API, you can:\n+ Create a new loyalty account.\n+ Adjust the balance of a loyalty account.\n+ Earn points to a loyalty account.\n+ Retrieve loyalty accounts.\n+ Handle webhooks when an account is updated or adjusted.\n\n> **Note:**\n> Before loyalty accounts can be created, the site's loyalty program must be active.\n> See the activate loyalty program endpoint to [learn how to activate the loyalty program using the API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fd9ad542-b05b-4eac-9043-46d31b971de9slug::activate-loyalty-program*fallback::https://dev.wix.com/api/rest/wix-loyalty-program/program/activate-loyalty-program).","sourceRepo":"git@github.com:wix-private/app-market.git","path":"proto/docs/introduction.md"}],"components":{"schemas":{"com.wixpress.loyalty.account.LoyaltyAccount":{"type":"object","properties":{"id":{"description":"Account ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactId":{"description":"Account owner's contact ID. See the Contacts API to [learn more about a site's contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object).","format":"GUID","readOnly":true,"title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"Account owner's member ID. See the Members API to [learn more about a site's members](https://dev.wix.com/api/rest/members/members/member-object).","format":"GUID","readOnly":true,"title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"points":{"description":"Information about the account totals.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.loyalty.account.Points","summary":"points","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rewardAvailable":{"description":"Whether the account has a reward available. `true` if the amount of points in `points.balance` are enough to redeem for a reward.","readOnly":true,"title":"rewardAvailable","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the account was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the account was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastActivityDate":{"description":"Account's last activity date and time.","readOnly":true,"title":"lastActivityDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the loyalty account is updated.\n\nTo prevent conflicting changes, the current `revision` must be passed when updating the loyalty account.\n\nIgnored when creating an account.","title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tier":{"description":"Tier information.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.loyalty.account.Tier","summary":"tier","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contact":{"description":"Contact information.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.loyalty.account.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pointsExpiration":{"description":"Points expiration information","readOnly":true,"$ref":"#/components/schemas/com.wixpress.loyalty.account.PointsExpiration","summary":"pointsExpiration","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LoyaltyAccount","description":"A loyalty account stores a customer's loyalty points balance. A site's customers can earn points to their account\nand redeem those points for rewards."},"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.account.Points":{"type":"object","properties":{"balance":{"description":"Current point balance.\n\nEqual to the sum of `earned` and `adjusted` points, minus `redeemed` points.","readOnly":true,"minimum":0,"title":"balance","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"earned":{"description":"Total earned points.","readOnly":true,"minimum":0,"title":"earned","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"adjusted":{"description":"Total adjusted points.","readOnly":true,"minimum":0,"title":"adjusted","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"redeemed":{"description":"Total redeemed points.","readOnly":true,"minimum":0,"title":"redeemed","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expired":{"description":"Total expired points.","readOnly":true,"minimum":0,"title":"expired","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Points","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.account.Tier":{"type":"object","properties":{"id":{"description":"Tier ID.\n\nThis field will not be returned if the account belongs to the base tier.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the tier information was last recalculated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"points":{"description":"Points earned and adjusted over the tier's current rolling window.","readOnly":true,"minimum":0,"title":"points","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Tier","description":"Tier information.\n\nThe Tiers API is currently unavailable, but the program may be activated and managed from a site's\n[loyalty dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/)."},"com.wixpress.loyalty.account.Contact":{"type":"object","properties":{"id":{"description":"Contact ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Contact's first and last name.","readOnly":true,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"picture":{"description":"Contact's profile picture.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.loyalty.account.Image","summary":"picture","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Contact's email addresses.","readOnly":true,"format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayName":{"description":"Contact's first and last name. If no name is provided, uses contact's email.","readOnly":true,"title":"displayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Contact","description":"Loyalty account's contact information"},"com.wixpress.loyalty.account.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"}}},"title":"Image","description":""},"com.wixpress.loyalty.account.PointsExpiration":{"type":"object","properties":{"expirationDate":{"description":"Date at which points are expiring.","readOnly":true,"title":"expirationDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expiringPointsAmount":{"description":"Amount of points that are going to expire at that date.","readOnly":true,"title":"expiringPointsAmount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PointsExpiration","description":""},"com.wixpress.loyalty.account.RewardAvailabilityUpdated":{"type":"object","properties":{"rewardAvailable":{"description":"True if rewards is available.","title":"rewardAvailable","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updateTrigger":{"description":"Source of this change.","title":"updateTrigger","type":"string","$ref":"#/components/schemas/com.wixpress.loyalty.account.RewardAvailabilityUpdated.UpdateTrigger","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RewardAvailabilityUpdated","description":""},"com.wixpress.loyalty.account.RewardAvailabilityUpdated.UpdateTrigger":{"type":"string","description":"","title":"UpdateTrigger","enum":["UNDEFINED","REWARD_UPDATED","BALANCE_UPDATED","TIERS_RECALCULATED"]},"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":""},"com.wixpress.loyalty.account.CreateAccountRequest":{"type":"object","properties":{"contactId":{"description":"Contact ID for a Wix site contact. See the Contacts API to\n[learn more about a site's contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object).","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateAccountRequest","description":""},"com.wixpress.loyalty.account.CreateAccountResponse":{"type":"object","properties":{"account":{"description":"Loyalty account.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateAccountResponse","description":""},"com.wixpress.loyalty.account.EarnPointsRequest":{"type":"object","properties":{"accountId":{"description":"Loyalty account ID.","format":"GUID","title":"accountId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"Amount of points to earn. Must be a positive, whole number.\n\nMin: `1`\n\nMax: `9999999`","minimum":1,"maximum":9999999,"title":"amount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of how the points were earned.\n\nMax: 100 characters","minLength":1,"maxLength":100,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the app that initiated the transaction.\n\nIf points were earned manually, then the `appId` is the Loyalty app's\n`wixAppId` of `553c79f3-5625-4f38-b14b-ef7c0d1e87df`. If points were earned in an automatic event,\nthen the `appId` is from that automation's `sourceAppId`.","minLength":1,"maxLength":100,"title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"idempotencyKey":{"description":"Unique string identifier generated by the app. Wix uses this identifier to recognize subsequent retries of the same request.\n\nPlease use `GUID` format.","minLength":1,"maxLength":256,"title":"idempotencyKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activityType":{"description":"Activity type.\n\nIf points were earned through automation it should be set to trigger key.","maxLength":100,"title":"activityType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"orderId":{"description":"Order id which was source of this transaction.","maxLength":512,"title":"orderId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EarnPointsRequest","description":""},"com.wixpress.loyalty.account.EarnPointsResponse":{"type":"object","properties":{"account":{"description":"Updated loyalty account.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"transactionId":{"description":"Transaction ID associated with the points earned.","format":"GUID","readOnly":true,"title":"transactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EarnPointsResponse","description":""},"com.wixpress.loyalty.account.PointsUpdated":{"type":"object","properties":{"account":{"description":"Updated account.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PointsUpdated","description":""},"com.wixpress.loyalty.account.FirstTransaction":{"type":"object","properties":{"account":{"description":"Updated account.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FirstTransaction","description":""},"com.wixpress.loyalty.account.AdjustPointsRequest":{"type":"object","properties":{"accountId":{"description":"Loyalty account ID.","format":"GUID","title":"accountId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description to explain the reason for the points adjustment.","minLength":1,"maxLength":100,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Each time the loyalty account is updated, `revision` increments by 1.\n\nThe current `revision` must be passed when adjusting points in the loyalty account. This\nensures you're working with the latest version of the loyalty account and prevents unintended overwrites.","minimum":1,"title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AdjustPointsRequest","description":"","oneOf":[{"description":"","summary":"type","$ref":"#/components/schemas/com.wixpress.loyalty.account.AdjustPointsRequest.type"}]},"com.wixpress.loyalty.account.AdjustPointsRequest.type":{"type":"object","title":"type","properties":{"balance":{"description":"Sets the account's point balance to this amount. Must be a positive, whole number or zero.\n\nThe net difference between this new balance and the previous balance will be reflected in the `adjusted` field of the customer's account.\n\nMin: `0`\n\nMax: `999999999`","minimum":0,"maximum":999999999,"title":"balance","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"Adjusts the account's point balance by this amount. Must be a whole number with a maximum of 7 digits.\nThe amount can be negative, but cannot be `0`.\n\nMin: `-9999999`\n\nMax: `9999999`","minimum":-9999999,"maximum":9999999,"title":"amount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.loyalty.account.AdjustPointsResponse":{"type":"object","properties":{"account":{"description":"Loyalty account.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"transactionId":{"description":"Transaction ID associated with the points adjustment.","format":"GUID","readOnly":true,"title":"transactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AdjustPointsResponse","description":""},"com.wixpress.loyalty.account.RedeemPointsRequest":{"type":"object","properties":{"accountId":{"description":"Loyalty account ID.","format":"GUID","title":"accountId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rewardId":{"description":"Reward ID. See [Rewards API](https://dev.wix.com/api/rest/loyalty/rewards/rewards-object) for more details.","format":"GUID","title":"rewardId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Number of times the given reward will be redeemed. Must be a positive whole number.","minimum":1,"title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time points are redeemed.\nTo prevent conflicting changes, the existing `revision` must be used when redeeming points.","minimum":1,"title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referenceEntityId":{"description":"Id of the entity that is being redeemed (e.g. orderId for order discount, couponId for coupon reward).","format":"GUID","title":"referenceEntityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RedeemPointsRequest","description":""},"com.wixpress.loyalty.account.RedeemPointsResponse":{"type":"object","properties":{"account":{"description":"Loyalty account.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"transactionId":{"description":"Transaction ID associated with the redemption.","format":"GUID","readOnly":true,"title":"transactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RedeemPointsResponse","description":""},"com.wixpress.loyalty.account.RedeemDeterminedAmountOfPointsRequest":{"type":"object","properties":{"accountId":{"description":"Loyalty account ID.","format":"GUID","title":"accountId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rewardId":{"description":"Reward ID. See [Rewards API](https://dev.wix.com/api/rest/loyalty/rewards/rewards-object) for more details.","format":"GUID","title":"rewardId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"points":{"description":"Number of points to be redeemed off the account.","minimum":1,"title":"points","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time points are redeemed.\nTo prevent conflicting changes, the existing `revision` must be used when redeeming points.","minimum":1,"title":"revision","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"referenceEntityId":{"description":"Id of the entity that is being redeemed (e.g. orderId for order discount, couponId for coupon reward).","format":"GUID","title":"referenceEntityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RedeemDeterminedAmountOfPointsRequest","description":""},"com.wixpress.loyalty.account.RedeemDeterminedAmountOfPointsResponse":{"type":"object","properties":{"account":{"description":"Loyalty account.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"transactionId":{"description":"Transaction ID associated with the redemption.","format":"GUID","readOnly":true,"title":"transactionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RedeemDeterminedAmountOfPointsResponse","description":""},"com.wixpress.loyalty.account.GetAccountRequest":{"type":"object","properties":{"id":{"description":"ID of the account to retrieve.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetAccountRequest","description":""},"com.wixpress.loyalty.account.GetAccountResponse":{"type":"object","properties":{"account":{"description":"Loyalty account.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetAccountResponse","description":""},"com.wixpress.loyalty.account.ListUserAccountsRequest":{"type":"object","properties":{"limit":{"description":"Number of items to load. Minimum `1`, maximum `50`.","minimum":1,"maximum":50,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListUserAccountsRequest","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.loyalty.account.ListUserAccountsResponse":{"type":"object","properties":{"accounts":{"description":"Loyalty accounts.","title":"accounts","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccountForMetaSite"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListUserAccountsResponse","description":""},"com.wixpress.loyalty.account.LoyaltyAccountForMetaSite":{"type":"object","properties":{"account":{"description":"Loyalty account.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metaSiteId":{"description":"Metasite ID.","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LoyaltyAccountForMetaSite","description":""},"com.wixpress.loyalty.account.GetProgramTotalsRequest":{"type":"object","properties":{},"title":"GetProgramTotalsRequest","description":""},"com.wixpress.loyalty.account.GetProgramTotalsResponse":{"type":"object","properties":{"points":{"description":"Point totals for the entire program.","$ref":"#/components/schemas/com.wixpress.loyalty.account.Points","summary":"points","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tierTotals":{"description":"Tier total for the entire program.","title":"tierTotals","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.TierTotal"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetProgramTotalsResponse","description":""},"com.wixpress.loyalty.account.TierTotal":{"type":"object","properties":{"id":{"description":"Tier ID. If no Tier ID provided, the ID is null. See [Base tier](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/introduction)for more information.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberOfAccounts":{"description":"Total number of loyalty account that belong to a particular Tier.","minimum":0,"title":"numberOfAccounts","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TierTotal","description":""},"com.wixpress.loyalty.account.GetCurrentMemberAccountRequest":{"type":"object","properties":{},"title":"GetCurrentMemberAccountRequest","description":""},"com.wixpress.loyalty.account.GetCurrentMemberAccountResponse":{"type":"object","properties":{"account":{"description":"Loyalty account.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCurrentMemberAccountResponse","description":""},"com.wixpress.loyalty.account.GetAccountBySecondaryIdRequest":{"type":"object","properties":{},"title":"GetAccountBySecondaryIdRequest","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.loyalty.account.GetAccountBySecondaryIdRequest.id"}]},"com.wixpress.loyalty.account.GetAccountBySecondaryIdRequest.id":{"type":"object","title":"id","properties":{"contactId":{"description":"Account owner's contact ID. See the [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) to learn more.","maxLength":50,"title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"Account owner's member ID. See the [Members API](https://dev.wix.com/api/rest/members/members/member-object) to learn more.","maxLength":50,"title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.loyalty.account.GetAccountBySecondaryIdResponse":{"type":"object","properties":{"account":{"description":"Loyalty account.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetAccountBySecondaryIdResponse","description":""},"com.wixpress.loyalty.account.ListAccountsRequest":{"type":"object","properties":{"contactIds":{"description":"List of contact IDs. See the [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) to learn more.","format":"GUID","maxItems":50,"title":"contactIds","type":"array","items":{"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":"ListAccountsRequest","description":"Options to use when retrieving a list of loyalty accounts."},"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.account.ListAccountsResponse":{"type":"object","properties":{"accounts":{"description":"Loyalty accounts.","title":"accounts","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount"},"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":"ListAccountsResponse","description":""},"wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wixpress.loyalty.account.SearchAccountsRequest":{"type":"object","properties":{"search":{"description":"Search options.","$ref":"#/components/schemas/wix.common.CursorSearch","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchAccountsRequest","description":"Options to use when search for loyalty accounts."},"wix.common.CursorSearch":{"type":"object","properties":{"filter":{"description":"A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]","maxItems":10,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregations":{"description":"Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.","maxItems":10,"title":"aggregations","type":"array","items":{"$ref":"#/components/schemas/wix.common.Aggregation"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields","$ref":"#/components/schemas/wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeZone":{"description":"UTC offset or IANA time zone. Valid values are\nISO 8601 UTC offsets, such as +02:00 or -06:00,\nand IANA time zone IDs, such as Europe/Rome\n\nAffects all filters and aggregations returned values.\nYou may override this behavior in a specific filter by providing\ntimestamps including time zone. e.g. `\"2023-12-20T10:52:34.795Z\"`","maxLength":50,"title":"timeZone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorSearch","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.common.CursorSearch.pagingMethod"}]},"wix.common.CursorSearch.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor pointing to page of results.\nWhen requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.","$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.Aggregation":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, should be unique, will appear in aggregation results","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation, client must provide matching aggregation field below","title":"type","type":"string","$ref":"#/components/schemas/wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, use dot notation to specify json path","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupBy":{"description":"deprecated, use `nested` instead","$ref":"#/components/schemas/wix.common.Aggregation.GroupByAggregation","summary":"groupBy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"deprecated, use `nested` instead","replacedBy":"nested","targetRemovalDate":"2024-03-30"}}}},"title":"Aggregation","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.common.Aggregation.kind"}]},"wix.common.Aggregation.kind":{"type":"object","title":"kind","properties":{"value":{"description":"Value aggregation","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation","$ref":"#/components/schemas/wix.common.Aggregation.RangeAggregation","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation","$ref":"#/components/schemas/wix.common.Aggregation.ScalarAggregation","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation","$ref":"#/components/schemas/wix.common.Aggregation.DateHistogramAggregation","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nested":{"description":"Nested aggregation","$ref":"#/components/schemas/wix.common.Aggregation.NestedAggregation","summary":"nested","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoubleValue","description":""},"wix.common.Aggregation.RangeAggregation.RangeBucket":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range. Required if to is not given","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range. Required if from is not given","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeBucket","description":""},"wix.common.Aggregation.ValueAggregation.SortType":{"type":"string","description":"","title":"SortType","enum":["COUNT","VALUE"]},"wix.common.Aggregation.ValueAggregation.SortDirection":{"type":"string","description":"","title":"SortDirection","enum":["DESC","ASC"]},"wix.common.Aggregation.ValueAggregation.MissingValues":{"type":"string","description":"","title":"MissingValues","enum":["EXCLUDE","INCLUDE"]},"wix.common.Aggregation.ValueAggregation.IncludeMissingValuesOptions":{"type":"object","properties":{"addToBucket":{"description":"Can specify custom bucket name. Defaults are [string -> \"N/A\"], [int -> \"0\"], [bool -> \"false\"] ...","maxLength":20,"title":"addToBucket","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IncludeMissingValuesOptions","description":""},"wix.common.ScalarType":{"type":"string","description":"","title":"ScalarType","enum":["UNKNOWN_SCALAR_TYPE","COUNT_DISTINCT","MIN","MAX","SUM","AVG"]},"wix.common.Aggregation.ValueAggregation":{"type":"object","properties":{"sortType":{"description":"Should sort by number of matches or value of the field","title":"sortType","type":"string","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation.SortType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sortDirection":{"description":"Should sort in ascending or descending order","title":"sortDirection","type":"string","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation.SortDirection","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"limit":{"description":"How many aggregations would you like to return? Can be between 1 and 250. 10 is the default.","title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"missingValues":{"description":"Should missing values be included or excluded from the aggregation results. Default is EXCLUDE","title":"missingValues","type":"string","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation.MissingValues","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueAggregation","description":"","oneOf":[{"description":"","summary":"options","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation.options"}]},"wix.common.Aggregation.ValueAggregation.options":{"type":"object","title":"options","properties":{"includeOptions":{"description":"Options for including missing values","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation.IncludeMissingValuesOptions","summary":"includeOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.Aggregation.NestedAggregation.NestedAggregationType":{"type":"string","description":"","title":"NestedAggregationType","enum":["UNKNOWN_AGGREGATION_TYPE","VALUE","RANGE","SCALAR","DATE_HISTOGRAM"]},"wix.common.Aggregation.RangeAggregation":{"type":"object","properties":{"buckets":{"description":"List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds","maxItems":50,"title":"buckets","type":"array","items":{"$ref":"#/components/schemas/wix.common.Aggregation.RangeAggregation.RangeBucket"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeAggregation","description":""},"wix.common.Aggregation.ScalarAggregation":{"type":"object","properties":{"type":{"description":"Define the operator for the scalar aggregation","title":"type","type":"string","$ref":"#/components/schemas/wix.common.ScalarType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarAggregation","description":""},"wix.common.Aggregation.DateHistogramAggregation":{"type":"object","properties":{"interval":{"description":"Interval for date histogram aggregation","title":"interval","type":"string","$ref":"#/components/schemas/wix.common.Aggregation.DateHistogramAggregation.Interval","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramAggregation","description":""},"wix.common.Aggregation.DateHistogramAggregation.Interval":{"type":"string","description":"","title":"Interval","enum":["UNKNOWN_INTERVAL","YEAR","MONTH","WEEK","DAY","HOUR","MINUTE","SECOND"]},"wix.common.Aggregation.NestedAggregation.NestedAggregationItem":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, should be unique, will appear in aggregation results","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation, client must provide matching aggregation field below","title":"type","type":"string","$ref":"#/components/schemas/wix.common.Aggregation.NestedAggregation.NestedAggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, use dont notation to specify json path","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregationItem","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.common.Aggregation.NestedAggregation.NestedAggregationItem.kind"}]},"wix.common.Aggregation.NestedAggregation.NestedAggregationItem.kind":{"type":"object","title":"kind","properties":{"value":{"description":"Value aggregation","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation","$ref":"#/components/schemas/wix.common.Aggregation.RangeAggregation","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation","$ref":"#/components/schemas/wix.common.Aggregation.ScalarAggregation","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation","$ref":"#/components/schemas/wix.common.Aggregation.DateHistogramAggregation","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.AggregationType":{"type":"string","description":"","title":"AggregationType","enum":["UNKNOWN_AGGREGATION_TYPE","VALUE","RANGE","SCALAR","DATE_HISTOGRAM","NESTED"]},"wix.common.Aggregation.NestedAggregation":{"type":"object","properties":{"nestedAggregations":{"description":"Flattened list of aggregations, where each next aggregation is nested within previous one","minItems":2,"maxItems":3,"title":"nestedAggregations","type":"array","items":{"$ref":"#/components/schemas/wix.common.Aggregation.NestedAggregation.NestedAggregationItem"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregation","description":"Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one"},"wix.common.Aggregation.GroupByAggregation":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, should be unique, will appear in aggregation results","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GroupByAggregation","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/wix.common.Aggregation.GroupByAggregation.kind"}]},"wix.common.Aggregation.GroupByAggregation.kind":{"type":"object","title":"kind","properties":{"value":{"description":"Value aggregation configuration","$ref":"#/components/schemas/wix.common.Aggregation.ValueAggregation","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.SearchDetails":{"type":"object","properties":{"mode":{"description":"Defines how separate search terms in `expression` are combined","title":"mode","type":"string","$ref":"#/components/schemas/wix.common.SearchDetails.Mode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expression":{"description":"Search term or expression","maxLength":100,"title":"expression","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path","maxLength":200,"maxItems":20,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fuzzy":{"description":"Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)","title":"fuzzy","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchDetails","description":""},"wix.common.SearchDetails.Mode":{"type":"string","description":"","title":"Mode","enum":["OR","AND"]},"com.wixpress.loyalty.account.SearchAccountsResponse":{"type":"object","properties":{"accounts":{"description":"Found accounts.","title":"accounts","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"aggregationData":{"description":"Aggregation data","$ref":"#/components/schemas/wix.common.AggregationData","summary":"aggregationData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchAccountsResponse","description":"Accounts found through provided search capabilities, along with paging and aggregation data of the results."},"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.AggregationData":{"type":"object","properties":{"results":{"description":"key = aggregation name (as derived from search request)","maxItems":10000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregationData","description":""},"wix.common.AggregationData.AggregationResults.ValueResults.ValueAggregationResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":100,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities with this value","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueAggregationResult","description":""},"wix.common.AggregationData.AggregationResults.RangeResults.RangeAggregationResult":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities in this range","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeAggregationResult","description":""},"wix.common.AggregationData.AggregationResults.NestedAggregationResults":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation, matches the one provided in request","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation that matches result","title":"type","type":"string","$ref":"#/components/schemas/wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by, matches the one provided in request","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedAggregationResults","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.NestedAggregationResults.result"}]},"wix.common.AggregationData.AggregationResults.NestedAggregationResults.result":{"type":"object","title":"result","properties":{"values":{"description":"Value aggregation results","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.ValueResults","summary":"values","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ranges":{"description":"Range aggregation results","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.RangeResults","summary":"ranges","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation results","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.AggregationData.AggregationResults.ValueResults":{"type":"object","properties":{"results":{"description":"List of value aggregations","maxItems":250,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.ValueResults.ValueAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueResults","description":""},"wix.common.AggregationData.AggregationResults.RangeResults":{"type":"object","properties":{"results":{"description":"List of ranges returned in same order as requested","maxItems":50,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.RangeResults.RangeAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeResults","description":""},"wix.common.AggregationData.AggregationResults.ScalarResult":{"type":"object","properties":{"type":{"description":"Type of scalar aggregation","title":"type","type":"string","$ref":"#/components/schemas/wix.common.ScalarType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"Value of the scalar aggregation","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarResult","description":""},"wix.common.AggregationData.AggregationResults.GroupByValueResults.NestedValueAggregationResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":1000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nestedResults":{"description":"Nested aggregations","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.NestedAggregationResults","summary":"nestedResults","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedValueAggregationResult","description":""},"wix.common.AggregationData.AggregationResults.NestedResults.ValueResult":{"type":"object","properties":{"value":{"description":"Value of the field","maxLength":1000,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities with this value","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValueResult","description":""},"wix.common.AggregationData.AggregationResults.NestedResults.RangeResult":{"type":"object","properties":{"from":{"description":"Inclusive lower bound of the range","title":"from","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"to":{"description":"Exclusive upper bound of the range","title":"to","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of entities in this range","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RangeResult","description":""},"wix.common.AggregationData.AggregationResults.NestedResults.ScalarResult":{"type":"object","properties":{"value":{"description":"Value of the scalar aggregation","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ScalarResult","description":""},"wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue":{"type":"object","properties":{},"title":"NestedResultValue","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue.result"}]},"wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue.result":{"type":"object","title":"result","properties":{"value":{"description":"Value aggregation result","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.NestedResults.ValueResult","summary":"value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"range":{"description":"Range aggregation result","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.NestedResults.RangeResult","summary":"range","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation result","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.NestedResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation result","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.NestedResults.ValueResult","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.AggregationData.AggregationResults.NestedResults.Results":{"type":"object","properties":{"results":{"description":"List of nested aggregations","title":"results","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.NestedResults.NestedResultValue"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Results","description":""},"wix.common.AggregationData.AggregationResults.DateHistogramResults.DateHistogramResult":{"type":"object","properties":{"value":{"description":"Date in ISO 8601 format","maxLength":100,"title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Count of documents in the bucket","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramResult","description":""},"wix.common.AggregationData.AggregationResults.GroupByValueResults":{"type":"object","properties":{"results":{"description":"List of value aggregations","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.GroupByValueResults.NestedValueAggregationResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GroupByValueResults","description":""},"wix.common.AggregationData.AggregationResults.DateHistogramResults":{"type":"object","properties":{"results":{"description":"List of date histogram aggregations","maxItems":200,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.DateHistogramResults.DateHistogramResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateHistogramResults","description":""},"wix.common.AggregationData.AggregationResults.NestedResults":{"type":"object","properties":{"results":{"description":"List of nested aggregations","maxItems":1000,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.NestedResults.Results"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NestedResults","description":"Results of `NESTED` aggregation type in a flattened form\naggregations in resulting array are keyed by requested aggregation `name`."},"wix.common.AggregationData.AggregationResults":{"type":"object","properties":{"name":{"description":"User-defined name of aggregation as derived from search request","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Type of aggregation that must match provided kind as derived from search request","title":"type","type":"string","$ref":"#/components/schemas/wix.common.AggregationType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldPath":{"description":"Field to aggregate by as derived from search request","maxLength":200,"title":"fieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AggregationResults","description":"","oneOf":[{"description":"","summary":"result","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.result"}]},"wix.common.AggregationData.AggregationResults.result":{"type":"object","title":"result","properties":{"values":{"description":"Value aggregation results","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.ValueResults","summary":"values","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ranges":{"description":"Range aggregation results","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.RangeResults","summary":"ranges","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scalar":{"description":"Scalar aggregation results","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.ScalarResult","summary":"scalar","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupedByValue":{"description":"Group by value aggregation results","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.GroupByValueResults","summary":"groupedByValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateHistogram":{"description":"Date histogram aggregation results","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.DateHistogramResults","summary":"dateHistogram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nested":{"description":"Nested aggregation results","$ref":"#/components/schemas/wix.common.AggregationData.AggregationResults.NestedResults","summary":"nested","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.loyalty.account.ExportAccountsRequest":{"type":"object","properties":{"query":{"description":"","$ref":"#/components/schemas/wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExportAccountsRequest","description":""},"wix.common.QueryV2":{"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\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.","title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.","title":"fieldsets","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryV2","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.common.QueryV2.pagingMethod"}]},"wix.common.QueryV2.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"com.wixpress.loyalty.account.ExportAccountsResponse":{"type":"object","properties":{"accounts":{"description":"","title":"accounts","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"","$ref":"#/components/schemas/wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExportAccountsResponse","description":""},"com.wixpress.loyalty.account.CountAccountsRequest":{"type":"object","properties":{"filter":{"description":"Filter object.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Free text to match in searchable fields.","$ref":"#/components/schemas/wix.common.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountAccountsRequest","description":"Options to use when looking up count of loyalty accounts."},"com.wixpress.loyalty.account.CountAccountsResponse":{"type":"object","properties":{"count":{"description":"","minimum":0,"title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountAccountsResponse","description":"Count of accounts found for given search query"},"com.wixpress.loyalty.account.BulkAdjustPointsRequest":{"type":"object","properties":{"search":{"description":"","$ref":"#/components/schemas/wix.common.CursorSearch","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAdjustPointsRequest","description":"","oneOf":[{"description":"","summary":"type","$ref":"#/components/schemas/com.wixpress.loyalty.account.BulkAdjustPointsRequest.type"}]},"com.wixpress.loyalty.account.BulkAdjustPointsRequest.type":{"type":"object","title":"type","properties":{"balance":{"description":"","minimum":0,"maximum":999999999,"title":"balance","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"amount":{"description":"","minimum":-9999999,"maximum":9999999,"title":"amount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.loyalty.account.BulkAdjustPointsResponse":{"type":"object","properties":{"asyncJobId":{"description":"","format":"GUID","readOnly":true,"title":"asyncJobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAdjustPointsResponse","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"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.loyalty.account.AccountsMerged":{"type":"object","properties":{"sourceAccounts":{"description":"Source accounts.","readOnly":true,"title":"sourceAccounts","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedAccount":{"description":"Merged account.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"updatedAccount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AccountsMerged","description":""},"com.wixpress.loyalty.tier.TiersRollingUpdate":{"type":"object","properties":{},"title":"TiersRollingUpdate","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"]},"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.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":""},"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.premium.subscriptionsmanager.api.v1.SubscriptionEvent":{"type":"object","properties":{"eventId":{"description":"ID of the subscription's event.","format":"GUID","title":"eventId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventDate":{"description":"Date and time of the event in\n[UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)\n`YYYY-MM-DDThh:mm:ss.sssZ` format.","title":"eventDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionEvent","description":"","oneOf":[{"description":"","summary":"event","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionEvent.event"}]},"com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionEvent.event":{"type":"object","title":"event","properties":{"created":{"description":"Triggered when a subscription is created.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionCreated","summary":"created","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"assigned":{"description":"Triggered when a subscription is assigned to a Wix site, including the initial\nassignment of a floating subscription or a re-assignement from a different site.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionAssigned","summary":"assigned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cancelled":{"description":"Triggered when a subscription is canceled.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionCancelled","summary":"cancelled","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"autoRenewTurnedOn":{"description":"Triggered when the subscription's auto renew is turned on.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionAutoRenewTurnedOn","summary":"autoRenewTurnedOn","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"autoRenewTurnedOff":{"description":"Triggered when the subscription's auto renew is turned off.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionAutoRenewTurnedOff","summary":"autoRenewTurnedOff","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"unassigned":{"description":"Triggered when a subscription is unassigned from a Wix site and becomes\nfloating.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionUnassigned","summary":"unassigned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"transferred":{"description":"Triggered when a subscription is transferred from one Wix account to another.\nA transfer includes cancelling the original subscription and creating a new\nsubscription for the target account. The event returns both the original\nand the new subscription.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionTransferred","summary":"transferred","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"recurringChargeSucceeded":{"description":"Triggered when a recurring charge succeeds for a subscription.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.RecurringChargeSucceeded","summary":"recurringChargeSucceeded","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contractSwitched":{"description":"Triggered when a subscription was updated including when its product has been\nup- or downgraded or the billing cycle is changed.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.ContractSwitched","summary":"contractSwitched","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nearEndOfPeriod":{"description":"Triggered when a subscription gets close to the end of its billing cycle.\nThe exact number of days is defined in the billing system.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionNearEndOfPeriod","summary":"nearEndOfPeriod","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pendingChange":{"description":"Triggered when a subscription is updated and the change doesn't happen\nimmediately but at the end of the current billing cycle.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionPendingChange","summary":"pendingChange","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionCreated":{"type":"object","properties":{"subscription":{"description":"Created subscription.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.Subscription","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Metadata for the `created` event.","title":"metadata","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reactivationData":{"description":"Subscription reactivation data.\nA subscription can be reactivated for example if it was incorrectly canceled because of fraud and then reactivated\nby the billing system","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.ReactivationData","summary":"reactivationData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionCreated","description":"Triggered when a subscription is created."},"com.wixpress.premium.subscriptionsmanager.api.v1.Subscription":{"type":"object","properties":{"id":{"description":"ID of the subscription.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"userId":{"description":"ID of the Wix account that purchased the subscription.","format":"GUID","title":"userId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"productId":{"description":"ID of the [product](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/products/product-object)\nfor which the subscription was purchased.","format":"GUID","title":"productId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdAt":{"description":"Date and time the subscription was created in\n[UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)\n`YYYY-MM-DDThh:mm:ss.sssZ` format.","title":"createdAt","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedAt":{"description":"Date and time the subscription was last updated in\n[UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)\n`YYYY-MM-DDThh:mm:ss.sssZ` format.","title":"updatedAt","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metaSiteId":{"description":"ID of the metasite that the subscription is assigned to.\nAvailable only when the subscription is assigned to a Wix site.\nSubscriptions for account level products can't be assigned to a Wix site.","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"billingReference":{"description":"Information about the system that manages the subscription's billing.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.BillingReference","summary":"billingReference","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cycle":{"description":"Information about the billing cycle of the subscription.","$ref":"#/components/schemas/com.wixpress.billing.api.v1.Cycle","summary":"cycle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Subscription status.\n\n+ `UNKNOWN`: Default status.\n+ `AUTO_RENEW_ON`: Subscription is active and automatically renews at the end of the current billing cycle.\n+ `AUTO_RENEW_OFF`: Subscription is active but expires at the end of the current billing cycle.\n+ `MANUAL_RECURRING`: Subscription is active and renews at the end of the current billing cycle, in case the customer takes an action related to the payment.\n+ `CANCELLED`: Subscription isn't active because it has been canceled.\n+ `TRANSFERRED`: Subscription isn't active because it has been transferred to a different account. A different active subscription was created for the target account.","title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionStatusEnum.SubscriptionStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"transferredAt":{"description":"Date and time the subscription was last transferred from one Wix account to\nanother in\n[UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)\n`YYYY-MM-DDThh:mm:ss.sssZ` format.","title":"transferredAt","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"productTypeId":{"description":"ID of the [product type](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/product-types/product-type-object)\nthat the product, for which the subscription was purchased, belongs to.","format":"GUID","title":"productTypeId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"Version number, which increments by 1 each time the subscription is updated.","title":"version","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"active":{"description":"Whether the subscription is active. Includes the statuses\n`\"AUTO_RENEW_ON\"`, `\"AUTO_RENEW_OFF\"`, and `\"MANUAL_RECURRING\"`.","title":"active","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalCreationDate":{"description":"Date and time the subscription was originally created in\n[UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)\n`YYYY-MM-DDThh:mm:ss.sssZ` format.\nDiffers from `createdAt` in case the subscription was originally created for a different Wix account and has been transferred.","title":"originalCreationDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Custom metadata about the subscription.","title":"metadata","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"countryCode":{"description":"2-letter country code in\n[ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)\nformat.","title":"countryCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Subscription","description":"A subscription holds information about a Premium product that a Wix account\nowner has purchased including details about the billing."},"com.wixpress.premium.subscriptionsmanager.api.v1.BillingReference":{"type":"object","properties":{"providerName":{"description":"Name of the billing system that manages the subscription.\n\n+ `\"UNKNOWN\"`: Default value.\n+ `\"SBS\"`: [Wix Billing](https://github.com/wix-p/premium-billing/tree/master/sbs).\n+ `\"LICENSER\"`:\n+ `\"BASS\"`: [Billing and Subscriptions System](https://dev.wix.com/docs/rest/internal-only/premium/subscriptions-by-billing-by-wix/introduction).\n+ `\"RESELLER\"`: [External Reseller](https://dev.wix.com/api/rest/account-level-apis/resellers/introduction).","title":"providerName","type":"string","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.BillingReference.ProviderName","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"providerReferenceId":{"description":"Current provider reference ID.","title":"providerReferenceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previousProviderReferenceIds":{"description":"Previous provider reference IDs. Used for when a subscription is extended, specifically for domains.","title":"previousProviderReferenceIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BillingReference","description":""},"com.wixpress.premium.subscriptionsmanager.api.v1.BillingReference.ProviderName":{"type":"string","description":"","title":"ProviderName","enum":["UNKNOWN","SBS","LICENSER","BASS","RESELLER","RECURRING_INVOICES"]},"com.wixpress.billing.api.v1.Cycle":{"type":"object","properties":{},"title":"Cycle","description":"","oneOf":[{"description":"","summary":"cycleSelector","$ref":"#/components/schemas/com.wixpress.billing.api.v1.Cycle.cycleSelector"}]},"com.wixpress.billing.api.v1.Cycle.cycleSelector":{"type":"object","title":"cycleSelector","properties":{"interval":{"description":"repetitive interval","$ref":"#/components/schemas/com.wixpress.billing.api.v1.Interval","summary":"interval","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oneTime":{"description":"one time","$ref":"#/components/schemas/com.wixpress.billing.api.v1.OneTime","summary":"oneTime","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.billing.api.v1.Interval":{"type":"object","properties":{"unit":{"description":"interval unit of measure","title":"unit","type":"string","$ref":"#/components/schemas/com.wixpress.billing.api.v1.Interval.IntervalUnit","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"number of interval","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Interval","description":""},"com.wixpress.billing.api.v1.Interval.IntervalUnit":{"type":"string","description":"","title":"IntervalUnit","enum":["UNKNOWN","DAY","WEEK","MONTH","YEAR"]},"com.wixpress.billing.api.v1.OneTime":{"type":"object","properties":{},"title":"OneTime","description":""},"com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionStatusEnum.SubscriptionStatus":{"type":"string","description":"","title":"SubscriptionStatus","enum":["UNKNOWN","AUTO_RENEW_ON","AUTO_RENEW_OFF","MANUAL_RECURRING","CANCELLED","TRANSFERRED"]},"com.wixpress.premium.subscriptionsmanager.api.v1.ReactivationData":{"type":"object","properties":{"reactivationReason":{"description":"","title":"reactivationReason","type":"string","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.ReactivationData.ReactivationReasonEnum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newEndOfPeriod":{"description":"In the event of reactivation after chargeback dispute, the subscription may be extended according to the\nnumber of days it was inactive during the time of resolving the dispute","title":"newEndOfPeriod","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oldEndOfPeriod":{"description":"The original end date, before the inactive period.","title":"oldEndOfPeriod","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"differenceInDays":{"description":"The difference in days between the new new_end_of_period and old_end_of_period","title":"differenceInDays","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReactivationData","description":"Triggered when a subscription is reactivated."},"com.wixpress.premium.subscriptionsmanager.api.v1.ReactivationData.ReactivationReasonEnum":{"type":"string","description":"Reason for subscription reactivation","title":"ReactivationReasonEnum","enum":["UNKNOWN","BILLING_STATUS_CHANGE","REACTIVATED_AFTER_CHARGEBACK"]},"com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionAssigned":{"type":"object","properties":{"subscription":{"description":"Assigned subscription.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.Subscription","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previousMetaSiteId":{"description":"ID of the metasite that the subscription has been assigned to before the update.","format":"GUID","title":"previousMetaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionAssigned","description":"Triggered when a subscription is assigned to a Wix site, including the initial\nassignment of a floating subscription or a re-assignement from a different site."},"com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionCancelled":{"type":"object","properties":{"subscription":{"description":"Canceled subscription.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.Subscription","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cancellationDetails":{"description":"Details about the cancellation including who canceled the subscription and why.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.CancellationDetails","summary":"cancellationDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"immediateCancel":{"description":"Whether the subscription is canceled immediately or expires at the end of the current billing cycle.\n\nDefault: `false`","title":"immediateCancel","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"canceledInFreeTrial":{"description":"Whether the subscription was canceled during the free trial period.","title":"canceledInFreeTrial","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionCancelled","description":"Triggered when a subscription is canceled."},"com.wixpress.premium.subscriptionsmanager.api.v1.CancellationDetails":{"type":"object","properties":{"cancellationCode":{"description":"Cancellation code.\n\nValues supported for cancellations on behalf of the billing system: `-1`, `-2`, `-3`, `-4`, `-5`, `-6`, `-7`, `-8`.\nFor cancellations on behalf of the site owner or the service provider `cancellationCode`\nis taken from the request of\n[Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).\n\n+ `-1`: The subscription has been cancelled by the billing system but none of the listed cancellation reasons applies.\n+ `-2`: There were payment problems.\n+ `-3`: There was a chargeback.\n+ `-4`: Customer support has canceled the subscription and issued a refund.\n+ `-5`: The site owner has changed their existing subscription.\n+ `-6`: The subscription has been transferred to a different Wix account.\n+ `-7`: The subscription has been canceled because the site owner hasn't manually authenticated the recurring payment during the subscription's grace period. For example, site owners must manually confirm recurring payments within 40 days when paying with boleto.\n+ `-8`: The Wix account that the subscription belonged to has been deleted.","title":"cancellationCode","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cancellationReason":{"description":"Cancellation reason. For cancellations on behalf of the site owner or the service provider `cancellationReason`\nis taken from the request of\n[Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).\nFor cancellations on behalf of the billing system `cancellationReason` is `null` or an empty string.","title":"cancellationReason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initiator":{"description":"Initiator of the cancellation. For `\"USER_REQUESTED\"` and `\"APP_MANAGED\"`,\n`cancellationCode` and `cancellationReason` are taken from the request of\n[Cancel Immediately](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately)\nor [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).\nFor `\"PASSIVE\"`, cancellations `cancellationCode` is automatically calculated and `cancellationReason`\nis `null` or an empty string.\n\n+ `\"UNKNOWN`: Default value.\n+ `\"USER_REQUESTED\"`: The Wix account owner has canceled the subscription.\n+ `\"APP_MANAGED\"`: The service provider has canceled the subscription.\n+ `\"PASSIVE\"`: The billing system has canceled the subscription. For example, in case of payment failure or fraud.","title":"initiator","type":"string","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.CancellationInitiatorEnum.Initiator","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CancellationDetails","description":"Information about the cancellation flow including who canceled the subscription and why it was canceled."},"com.wixpress.premium.subscriptionsmanager.api.v1.CancellationInitiatorEnum.Initiator":{"type":"string","description":"","title":"Initiator","enum":["UNKNOWN","USER_REQUESTED","APP_MANAGED","PASSIVE"]},"com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionAutoRenewTurnedOn":{"type":"object","properties":{"subscription":{"description":"Subscription for which auto renew is turned on.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.Subscription","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initiator":{"description":"Supported values: `USER`, `APP`.\n\nInformation about who turned auto renew on.\n+ `\"USER\"`: The site owner who purchased the subscription has turned auto renew on.\n+ `\"APP\"`: The service provider has turned auto renew on.","title":"initiator","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionAutoRenewTurnedOn","description":"Triggered when the subscription's auto renew is turned on."},"com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionAutoRenewTurnedOff":{"type":"object","properties":{"subscription":{"description":"Subscription for which auto renew is turned off.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.Subscription","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cancellationDetails":{"description":"Details about the cancellation including who canceled the subscription and why.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.CancellationDetails","summary":"cancellationDetails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"immediateCancel":{"description":"Whether the subscription is immediately canceled or expires at the end of the current billing cycle.\n\nDefault: `false`","title":"immediateCancel","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionAutoRenewTurnedOff","description":"Triggered when the subscription's auto renew is turned off."},"com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionUnassigned":{"type":"object","properties":{"subscription":{"description":"Unassigned subscription.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.Subscription","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previousMetaSiteId":{"description":"ID of the metasite that the subscription has been assigned to before the event.","format":"GUID","title":"previousMetaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"unassignReason":{"description":"Reason why the subscription is unassigned.\n\n+ `\"UNKNOWN\"`: Default value.\n+ `\"USER_REQUESTED\"`: The Wix account owner has unassigned the subscription.\n+ `\"REPLACED_BY_ANOTHER_SUBSCRIPTION\"`: A different subscription that replaces this subscription is assigned to the site.","title":"unassignReason","type":"string","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionUnassigned.UnassignReason","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionUnassigned","description":"Triggered when a subscription is unassigned from a Wix site and becomes\nfloating."},"com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionUnassigned.UnassignReason":{"type":"string","description":"","title":"UnassignReason","enum":["UNKNOWN","USER_REQUESTED","REPLACED_BY_ANOTHER_SUBSCRIPTION"]},"com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionTransferred":{"type":"object","properties":{"originSubscription":{"description":"Original subscription that was canceled for the transfer.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.Subscription","summary":"originSubscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"targetSubscription":{"description":"Newly created subscription for the target account.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.Subscription","summary":"targetSubscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionTransferred","description":"Triggered when a subscription is transferred from one Wix account to another.\nA transfer includes cancelling the original subscription and creating a new\nsubscription for the target account. The event returns both the original\nand the new subscription."},"com.wixpress.premium.subscriptionsmanager.api.v1.RecurringChargeSucceeded":{"type":"object","properties":{"subscription":{"description":"Subscription for which the recurring charge has succeeded.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.Subscription","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"freeTrialPeriodEnd":{"description":"Indication that there was a successful charge at the end of the free trial period","title":"freeTrialPeriodEnd","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RecurringChargeSucceeded","description":"Triggered when a recurring charge succeeds for a subscription."},"com.wixpress.premium.subscriptionsmanager.api.v1.ContractSwitched":{"type":"object","properties":{"subscription":{"description":"Updated subscription.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.Subscription","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previousCycle":{"description":"Billing cycle before the update.","$ref":"#/components/schemas/com.wixpress.billing.api.v1.Cycle","summary":"previousCycle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previousProductId":{"description":"ID of the product belonging to the subscription before the update.","format":"GUID","title":"previousProductId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previousProductTypeId":{"description":"ID of the product type that the subscription's original product belonged to before the update.","format":"GUID","title":"previousProductTypeId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contractSwitchType":{"description":"Update type. __Note__: Doesn't include information about a product adjustment.\nFor that purpose, see `productAdjustment`.\n\n+ `\"NOT_APPLICABLE\"`: Default value.\n+ `\"ADDITIONAL_QUANTITY\"`: An increased usage quota is added to the subscription. For example, a second mailbox is added to a subscription that previously included a single mailbox.\n+ `\"CREDIT_UNUSED_PERIOD\"`: The subscription is upgraded and the new price is less than the regular price. The new price applies to every billing cycle, not just the first cycle.\n+ `\"REFUND_PRICE_DIFF\"`: Not implemented.\n+ `\"ADJUST_PERIOD_END\"`: Not implemented.\n+ `\"DOWNGRADE_GRACE_PERIOD\"`: For downgrades during the grace period. In this situation, the site owner hasn’t paid yet and must immediately pay for the downgraded subscription.\n+ `\"FULL_AMOUNT_PERIOD\"`: For upgrades in which the site owner retains unused benefits. For example, site owners upgrading a Facebook Ads subscription retain their unused FB Ads credit. The unused credit is added to the new credit.\n+ `\"END_OF_PERIOD\"`: The subscription's billing current cycle is extended because of a downgrade.\n+ `\"PENDING_CHANGES\"`: The subscription's billing is updated, but the change doesn't apply immediately. Instead, the update becomes effective at the end of current billing cycle.\n+ `\"DOWNGRADE_RENEWAL\"`: The subscription is downgraded because of a declined payment. This prevents subscriptions from churning.","title":"contractSwitchType","type":"string","$ref":"#/components/schemas/com.wixpress.premium.billingnotifications.api.v1.ContractSwitchType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previousMetaSiteId":{"description":"ID of the metasite the subscription has been assigned to previously.\nAvailable only in case the subscription is assigned to a different site.","format":"GUID","title":"previousMetaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contractSwitchReason":{"description":"Update reason.\n\n+ `\"PRICE_INCREASE\"`: The subscription's price has been increased.\n+ `\"EXTERNAL_PROVIDER_TRIGGER\"`: Any reason other than a price increase.","title":"contractSwitchReason","type":"string","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.ContractSwitchReason.ContractSwitchReason","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"productPriceIncreaseData":{"description":"Information about the price update. Available only for updates with a price increase.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.ProductPriceIncreaseData","summary":"productPriceIncreaseData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"productAdjustment":{"description":"Information about a product adjustment. For example, a downgrade.\n__Note__: This isn't the same as `contractSwitchType`.\n\n+ `NOT_APPLICABLE`: There is no information about whether the product has been up- or downgraded.\n+ `DOWNGRADE`: The product has been downgraded.","title":"productAdjustment","type":"string","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.ProductAdjustment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContractSwitched","description":"Triggered when a subscription was updated including when its product has been\nup- or downgraded or the billing cycle is changed."},"com.wixpress.premium.billingnotifications.api.v1.ContractSwitchType":{"type":"string","description":"Copied from SBS","title":"ContractSwitchType","enum":["NOT_APPLICABLE","ADDITIONAL_QUANTITY","CREDIT_UNUSED_PERIOD","REFUND_PRICE_DIFF","ADJUST_PERIOD_END","DOWNGRADE_GRACE_PERIOD","FULL_AMOUNT_PERIOD","END_OF_PERIOD","PENDING_CHANGES","DOWNGRADE_RENEWAL"]},"com.wixpress.premium.subscriptionsmanager.api.v1.ContractSwitchReason.ContractSwitchReason":{"type":"string","description":"","title":"ContractSwitchReason","enum":["EXTERNAL_PROVIDER_TRIGGER","PRICE_INCREASE"]},"com.wixpress.premium.subscriptionsmanager.api.v1.ProductPriceIncreaseData":{"type":"object","properties":{"previousPrice":{"description":"Price of the subscription before the update.","format":"DECIMAL_VALUE","title":"previousPrice","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailTemplateSelector":{"description":"A value that is used in order to select the correct email template to send the user regarding the price increase.","title":"emailTemplateSelector","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"segmentName":{"description":"Used to differentiate between migration segments. Does not have to be unique per segment.","title":"segmentName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"priceIncreaseTrigger":{"description":"Used to determine how the price increase was triggered.","title":"priceIncreaseTrigger","type":"string","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.PriceIncreaseTrigger","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProductPriceIncreaseData","description":"Triggered when a subscription's price is increased."},"com.wixpress.premium.subscriptionsmanager.api.v1.PriceIncreaseTrigger":{"type":"string","description":"Reason for Price Increase Trigger","title":"PriceIncreaseTrigger","enum":["NEAR_RENEWAL","RECURRING_SUCCESS","MANUAL"]},"com.wixpress.premium.subscriptionsmanager.api.v1.ProductAdjustment":{"type":"string","description":"Triggered when a subscription's product is adusted.","title":"ProductAdjustment","enum":["NOT_APPLICABLE","DOWNGRADE"]},"com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionNearEndOfPeriod":{"type":"object","properties":{"subscription":{"description":"Subscription that got close to the end of its billing cycle.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.Subscription","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"inFreeTrial":{"description":"Whether the subscription is within the free trial period.","title":"inFreeTrial","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionNearEndOfPeriod","description":"Triggered when a subscription gets close to the end of its billing cycle.\nThe exact number of days is defined in the billing system."},"com.wixpress.premium.subscriptionsmanager.api.v1.SubscriptionPendingChange":{"type":"object","properties":{"subscription":{"description":"Subscription for which a pending update is triggered.","$ref":"#/components/schemas/com.wixpress.premium.subscriptionsmanager.api.v1.Subscription","summary":"subscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscriptionPendingChange","description":"Triggered when a subscription is updated and the change doesn't happen\nimmediately but at the end of the current billing cycle."},"com.wixpress.loyalty.account.ContactSyncRequest":{"type":"object","properties":{"contactIds":{"description":"","format":"GUID","title":"contactIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactId":{"description":"","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactSyncRequest","description":""},"com.wixpress.loyalty.account.BulkUpsertAccountsRequest":{"type":"object","properties":{"accounts":{"description":"List of contactIds + points to either insert as new loyalty accounts, or update if contacts already exist as loyalty accounts","minItems":1,"maxItems":100,"title":"accounts","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.AccountToUpsert"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnAccounts":{"description":"If true, the upserted accounts are returned in response","title":"returnAccounts","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"If true, the upserted accounts are returned in response","targetRemovalDate":"2024-02-01"}}},"description":{"description":"Description of the action","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpsertAccountsRequest","description":""},"com.wixpress.loyalty.account.AccountToUpsert":{"type":"object","properties":{"contactId":{"description":"","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pointsBalance":{"description":"","minimum":0,"maximum":9999999,"title":"pointsBalance","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AccountToUpsert","description":""},"com.wixpress.loyalty.account.BulkUpsertAccountsResponse":{"type":"object","properties":{"result":{"description":"Loyalty accounts that were created or updated","title":"result","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.account.BulkAccountResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Numbers of successes and failures","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpsertAccountsResponse","description":""},"com.wixpress.loyalty.account.BulkAccountResult":{"type":"object","properties":{"account":{"description":"The created/updated account is returned if specified so in request message.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"LoyaltyAccount metadata.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAccountResult","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":""},"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.account.SetMissingMemberIdRequest":{"type":"object","properties":{"accountId":{"description":"ID of the account to retrieve.","format":"GUID","title":"accountId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetMissingMemberIdRequest","description":""},"com.wixpress.loyalty.account.SetMissingMemberIdResponse":{"type":"object","properties":{"account":{"description":"Loyalty account.","$ref":"#/components/schemas/com.wixpress.loyalty.account.LoyaltyAccount","summary":"account","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SetMissingMemberIdResponse","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":"Account","description":"A loyalty account stores a customer's loyalty points balance. A site's customers can earn points to their account\nand redeem those points for rewards.","fqdn":"wix.loyalty.v1.account"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Loyalty Accounts\n\nThe loyalty accounts API allows a site owner to create and manage its customers' loyalty accounts. The loyalty accounts\nmaintain a customer's balance of loyalty points. \n\nWith the loyalty accounts API, you can:\n+ Create a new loyalty account.\n+ Adjust the balance of a loyalty account.\n+ Earn points to a loyalty account.\n+ Retrieve loyalty accounts.\n+ Handle webhooks when an account is updated or adjusted.\n\n> **Note:**\n> Before loyalty accounts can be created, the site's loyalty program must be active.\n> See the activate loyalty program endpoint to [learn how to activate the loyalty program using the API](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fd9ad542-b05b-4eac-9043-46d31b971de9slug::activate-loyalty-program*fallback::https://dev.wix.com/api/rest/wix-loyalty-program/program/activate-loyalty-program)."}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Count Accounts

Permission Scopes