{"id":"e9543b60-544f-4824-8f7d-1503ff9fc7cb","createdDate":"2024-12-10T07:21:23.470Z","updatedDate":"2024-12-10T07:21:23.470Z","resourceId":"ec282ae5-4a5d-4d95-aedb-147dcc90e28e","api":{"schema":{"object":{"displayName":"Tip Settings Object","description":"Tip settings define how tips are calculated and distributed among staff. When\nWix Tips is installed, default settings are automatically created. You can't\ndelete these default settings but you can update them. Creating additional\nsettings allows business owners to customize tip screens for different payment\nterminals or set specific presets for various products or services.","slug":"tip-settings-object","$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git"},"methods":[{"summary":"Query Tip Settings","description":"Retrieves a list of tip of up to 100 tip settings, given the provided paging, filtering, and sorting.\n\nQuery Tip Settings runs with these defaults, which you can override:\n- `cursorPaging.limit` is `50`.\n- Sorted by `id` in ascending order.\n\nFor field support for filters and sorting, see\n[Tip Settings: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/supported-filters).\n\nUse [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)\nwhen setting a filter for dates.\n\nTo learn about working with _Query_ endpoints, see\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging),\nand [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).","operationId":"wix.tips.settings.v1.TipSettingsService.QueryTipSettings","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.tips.settings.v1.QueryTipSettingsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryTipSettingsRequest","description":"","properties":{"query":{"description":"WQL expression","$ref":"#/components/schemas/wix.tips.settings.v1.upstream.wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["query"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.tips.settings.v1.TipSettingsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_TIPS.TIP_SETTINGS_READ"],"protoArtifactId":"com.wixpress.tips.settings:tip-settings","serviceArtifactId":"com.wixpress.tips.settings.tip-settings","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.tips.settings.v1.QueryTipSettingsRequest","responseMessage":"wix.tips.settings.v1.QueryTipSettingsResponse"},"legacyExamples":[{"name":"QueryTipSettings","serviceName":"TipSettingsService","type":"METHOD","content":{"title":"Query tip settings","request":"curl -X POST \\\n'https://www.wixapis.com/tip-settings/v1/tip-settings/query' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\","response":"{\n \"tipSettings\": [\n {\n \"id\": \"1338729c-7255-48f1-a66e-f6a8e4b6f9f3\",\n \"tipType\": \"PERCENTAGE\",\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10,\n \"default\": null\n },\n {\n \"value\": 15,\n \"default\": null\n }\n ],\n \"allowCustomerTip\": false,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-23T08:16:35.039Z\",\n \"updatedDate\": \"2024-09-23T08:16:35.039Z\",\n \"default\": false,\n \"appId\": null,\n \"extendedFields\": null\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git"},"httpMethod":"post","path":"/v1/tip-settings/query","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://_/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"_","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://*.dev.wix-code.com/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://www.wixapis.com/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/tip-settings","destinationPath":"","url":"www.wixapis.com","serviceName":"wix.tips.settings.v1.TipSettingsService"}}],"triggeredEvents":[],"serviceName":"wix.tips.settings.v1.TipSettingsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_TIPS.TIP_SETTINGS_READ"],"protoArtifactId":"com.wixpress.tips.settings:tip-settings","serviceArtifactId":"com.wixpress.tips.settings.tip-settings","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.tips.settings.v1.QueryTipSettingsRequest","responseMessage":"wix.tips.settings.v1.QueryTipSettingsResponse"},"legacyExamples":[{"name":"QueryTipSettings","serviceName":"TipSettingsService","type":"METHOD","content":{"title":"Query tip settings","request":"curl -X POST \\\n'https://www.wixapis.com/tip-settings/v1/tip-settings/query' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\","response":"{\n \"tipSettings\": [\n {\n \"id\": \"1338729c-7255-48f1-a66e-f6a8e4b6f9f3\",\n \"tipType\": \"PERCENTAGE\",\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10,\n \"default\": null\n },\n {\n \"value\": 15,\n \"default\": null\n }\n ],\n \"allowCustomerTip\": false,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-23T08:16:35.039Z\",\n \"updatedDate\": \"2024-09-23T08:16:35.039Z\",\n \"default\": false,\n \"appId\": null,\n \"extendedFields\": null\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git","contentLink":{"displayName":"Query Tip Settings","slugifiedName":"query-tip-settings"},"permissionScopes":[{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"}],"isAdminMethod":false},{"summary":"Create Tip Settings","description":"Creates a `tipSettings` object.\n\n\nYou can't create a `tipSettings` object with `{\"default\": true}`.","operationId":"wix.tips.settings.v1.TipSettingsService.CreateTipSettings","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.tips.settings.v1.CreateTipSettingsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateTipSettingsRequest","description":"","properties":{"tipSettings":{"description":"Tip settings to create.","$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings","summary":"tipSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["tipSettings"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.tips.settings.v1.TipSettingsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_HAVE_MORE_THAN_ONE_DEFAULT_PRESET","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CANNOT_HAVE_MORE_THAN_ONE_DEFAULT_PRESET"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRESET_PERCENTAGE_TOO_HIGH","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRESET_PERCENTAGE_TOO_HIGH"}}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_TIPS.TIP_SETTINGS_CREATE"],"protoArtifactId":"com.wixpress.tips.settings:tip-settings","serviceArtifactId":"com.wixpress.tips.settings.tip-settings","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.tips.settings.v1.CreateTipSettingsRequest","responseMessage":"wix.tips.settings.v1.CreateTipSettingsResponse"},"legacyExamples":[{"name":"CreateTipSettings","serviceName":"TipSettingsService","type":"METHOD","content":{"title":"Create tip settings","request":"curl -X POST \\\n'https://www.wixapis.com/tip-settings/v1/tip-settings' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\\n-d '{\n \"tipSettings\": {\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10\n },\n {\n \"value\": 15\n }\n ],\n \"tipType\": \"PERCENTAGE\",\n \"allowCustomerTip\": false,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\",\n \"default\": false\n }\n}'","response":"{\n \"tipSettings\": {\n \"id\": \"1338729c-7255-48f1-a66e-f6a8e4b6f9f3\",\n \"tipType\": \"PERCENTAGE\",\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10,\n \"default\": null\n },\n {\n \"value\": 15,\n \"default\": null\n }\n ],\n \"allowCustomerTip\": false,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-23T08:16:35.039Z\",\n \"updatedDate\": \"2024-09-23T08:16:35.039Z\",\n \"default\": false,\n \"appId\": null,\n \"extendedFields\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git"},"httpMethod":"post","path":"/v1/tip-settings","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://_/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"_","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://*.dev.wix-code.com/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://www.wixapis.com/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/tip-settings","destinationPath":"","url":"www.wixapis.com","serviceName":"wix.tips.settings.v1.TipSettingsService"}}],"triggeredEvents":[],"serviceName":"wix.tips.settings.v1.TipSettingsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_HAVE_MORE_THAN_ONE_DEFAULT_PRESET","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CANNOT_HAVE_MORE_THAN_ONE_DEFAULT_PRESET"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRESET_PERCENTAGE_TOO_HIGH","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRESET_PERCENTAGE_TOO_HIGH"}}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_TIPS.TIP_SETTINGS_CREATE"],"protoArtifactId":"com.wixpress.tips.settings:tip-settings","serviceArtifactId":"com.wixpress.tips.settings.tip-settings","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.tips.settings.v1.CreateTipSettingsRequest","responseMessage":"wix.tips.settings.v1.CreateTipSettingsResponse"},"legacyExamples":[{"name":"CreateTipSettings","serviceName":"TipSettingsService","type":"METHOD","content":{"title":"Create tip settings","request":"curl -X POST \\\n'https://www.wixapis.com/tip-settings/v1/tip-settings' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\\n-d '{\n \"tipSettings\": {\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10\n },\n {\n \"value\": 15\n }\n ],\n \"tipType\": \"PERCENTAGE\",\n \"allowCustomerTip\": false,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\",\n \"default\": false\n }\n}'","response":"{\n \"tipSettings\": {\n \"id\": \"1338729c-7255-48f1-a66e-f6a8e4b6f9f3\",\n \"tipType\": \"PERCENTAGE\",\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10,\n \"default\": null\n },\n {\n \"value\": 15,\n \"default\": null\n }\n ],\n \"allowCustomerTip\": false,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-23T08:16:35.039Z\",\n \"updatedDate\": \"2024-09-23T08:16:35.039Z\",\n \"default\": false,\n \"appId\": null,\n \"extendedFields\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git","contentLink":{"displayName":"Create Tip Settings","slugifiedName":"create-tip-settings"},"permissionScopes":[{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"}],"isAdminMethod":true},{"summary":"Update Tip Settings","description":"Updates a `tipSettings` object.\n\n\nYou can't update the `default` field.","operationId":"wix.tips.settings.v1.TipSettingsService.UpdateTipSettings","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.tips.settings.v1.UpdateTipSettingsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateTipSettingsRequest","description":"","properties":{"tipSettings":{"description":"Tip settings to update.","$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings","summary":"tipSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["tipSettings"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.tips.settings.v1.TipSettingsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DEFAULT_SETTINGS_ALREADY_EXISTS","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DEFAULT_SETTINGS_ALREADY_EXISTS"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_HAVE_MORE_THAN_ONE_DEFAULT_PRESET","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CANNOT_HAVE_MORE_THAN_ONE_DEFAULT_PRESET"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRESET_PERCENTAGE_TOO_HIGH","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRESET_PERCENTAGE_TOO_HIGH"}}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_TIPS.TIP_SETTINGS_UPDATE"],"protoArtifactId":"com.wixpress.tips.settings:tip-settings","serviceArtifactId":"com.wixpress.tips.settings.tip-settings","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.tips.settings.v1.UpdateTipSettingsRequest","responseMessage":"wix.tips.settings.v1.UpdateTipSettingsResponse"},"legacyExamples":[{"name":"UpdateTipSettings","serviceName":"TipSettingsService","type":"METHOD","content":{"title":"Update tip settings","request":"curl -X PATCH \\\n'https://www.wixapis.com/tip-settings/v1/tip-settings' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\\n-d '{\n \"tipSettings\": {\n \"id\": \"1338729c-7255-48f1-a66e-f6a8e4b6f9f3\",\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10\n },\n {\n \"value\": 15\n }\n ],\n \"tipType\": \"PERCENTAGE\",\n \"allowCustomerTip\": true,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\",\n \"default\": false,\n \"revision\": \"1\"\n },\n \"field_mask\": {\n \"paths\": [\n \"allowCustomerTip\"\n ]\n }\n}'","response":"{\n \"tipSettings\": {\n \"id\": \"1338729c-7255-48f1-a66e-f6a8e4b6f9f3\",\n \"tipType\": \"PERCENTAGE\",\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10,\n \"default\": null\n },\n {\n \"value\": 15,\n \"default\": null\n }\n ],\n \"allowCustomerTip\": true,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-09-23T08:16:35.039Z\",\n \"updatedDate\": \"2024-09-23T08:16:35.039Z\",\n \"default\": false,\n \"appId\": null,\n \"extendedFields\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git"},"httpMethod":"patch","path":"/v1/tip-settings","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://_/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"_","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://*.dev.wix-code.com/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://www.wixapis.com/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/tip-settings","destinationPath":"","url":"www.wixapis.com","serviceName":"wix.tips.settings.v1.TipSettingsService"}}],"triggeredEvents":[],"serviceName":"wix.tips.settings.v1.TipSettingsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DEFAULT_SETTINGS_ALREADY_EXISTS","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DEFAULT_SETTINGS_ALREADY_EXISTS"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_HAVE_MORE_THAN_ONE_DEFAULT_PRESET","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CANNOT_HAVE_MORE_THAN_ONE_DEFAULT_PRESET"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRESET_PERCENTAGE_TOO_HIGH","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRESET_PERCENTAGE_TOO_HIGH"}}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_TIPS.TIP_SETTINGS_UPDATE"],"protoArtifactId":"com.wixpress.tips.settings:tip-settings","serviceArtifactId":"com.wixpress.tips.settings.tip-settings","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.tips.settings.v1.UpdateTipSettingsRequest","responseMessage":"wix.tips.settings.v1.UpdateTipSettingsResponse"},"legacyExamples":[{"name":"UpdateTipSettings","serviceName":"TipSettingsService","type":"METHOD","content":{"title":"Update tip settings","request":"curl -X PATCH \\\n'https://www.wixapis.com/tip-settings/v1/tip-settings' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\\n-d '{\n \"tipSettings\": {\n \"id\": \"1338729c-7255-48f1-a66e-f6a8e4b6f9f3\",\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10\n },\n {\n \"value\": 15\n }\n ],\n \"tipType\": \"PERCENTAGE\",\n \"allowCustomerTip\": true,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\",\n \"default\": false,\n \"revision\": \"1\"\n },\n \"field_mask\": {\n \"paths\": [\n \"allowCustomerTip\"\n ]\n }\n}'","response":"{\n \"tipSettings\": {\n \"id\": \"1338729c-7255-48f1-a66e-f6a8e4b6f9f3\",\n \"tipType\": \"PERCENTAGE\",\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10,\n \"default\": null\n },\n {\n \"value\": 15,\n \"default\": null\n }\n ],\n \"allowCustomerTip\": true,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-09-23T08:16:35.039Z\",\n \"updatedDate\": \"2024-09-23T08:16:35.039Z\",\n \"default\": false,\n \"appId\": null,\n \"extendedFields\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git","contentLink":{"displayName":"Update Tip Settings","slugifiedName":"update-tip-settings"},"permissionScopes":[{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"}],"isAdminMethod":true},{"summary":"Create Default Tip Settings","description":"Creates a default `tipSettings` object.\n\n\nThe call fails if there is already an existing default `tipSettings` object.","operationId":"wix.tips.settings.v1.TipSettingsService.CreateDefaultTipSettings","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.tips.settings.v1.CreateDefaultTipSettingsResponse","description":""}},"deprecated":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateDefaultTipSettingsRequest","description":"","properties":{"tipSettings":{"description":"Dafault tip settings to create.","$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings","summary":"tipSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["tipSettings"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.tips.settings.v1.TipSettingsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DEFAULT_SETTINGS_ALREADY_EXISTS","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DEFAULT_SETTINGS_ALREADY_EXISTS"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_HAVE_MORE_THAN_ONE_DEFAULT_PRESET","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CANNOT_HAVE_MORE_THAN_ONE_DEFAULT_PRESET"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRESET_PERCENTAGE_TOO_HIGH","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRESET_PERCENTAGE_TOO_HIGH"}}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_TIPS.TIP_SETTINGS_CREATE"],"protoArtifactId":"com.wixpress.tips.settings:tip-settings","serviceArtifactId":"com.wixpress.tips.settings.tip-settings","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.tips.settings.v1.CreateDefaultTipSettingsRequest","responseMessage":"wix.tips.settings.v1.CreateDefaultTipSettingsResponse"},"legacyExamples":[{"name":"CreateDefaultTipSettings","serviceName":"TipSettingsService","type":"METHOD","content":{"title":"Create default tip settings","request":"curl -X POST \\\n'https://www.wixapis.com/tip-settings/v1/tip-settings/create-default' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\\n-d '{\n \"tipSettings\": {\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10\n },\n {\n \"value\": 15\n }\n ],\n \"tipType\": \"PERCENTAGE\",\n \"allowCustomerTip\": false,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\"\n }\n}'","response":"{\n \"tipSettings\": {\n \"id\": \"1338729c-7255-48f1-a66e-f6a8e4b6f9f3\",\n \"tipType\": \"PERCENTAGE\",\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10,\n \"default\": null\n },\n {\n \"value\": 15,\n \"default\": null\n }\n ],\n \"allowCustomerTip\": false,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-23T08:16:35.039Z\",\n \"updatedDate\": \"2024-09-23T08:16:35.039Z\",\n \"default\": true,\n \"appId\": null,\n \"extendedFields\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git"},"httpMethod":"post","path":"/v1/tip-settings/create-default","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://_/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"_","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://*.dev.wix-code.com/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://www.wixapis.com/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/tip-settings","destinationPath":"","url":"www.wixapis.com","serviceName":"wix.tips.settings.v1.TipSettingsService"}}],"triggeredEvents":[],"serviceName":"wix.tips.settings.v1.TipSettingsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DEFAULT_SETTINGS_ALREADY_EXISTS","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"DEFAULT_SETTINGS_ALREADY_EXISTS"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_HAVE_MORE_THAN_ONE_DEFAULT_PRESET","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CANNOT_HAVE_MORE_THAN_ONE_DEFAULT_PRESET"}},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PRESET_PERCENTAGE_TOO_HIGH","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"PRESET_PERCENTAGE_TOO_HIGH"}}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_TIPS.TIP_SETTINGS_CREATE"],"protoArtifactId":"com.wixpress.tips.settings:tip-settings","serviceArtifactId":"com.wixpress.tips.settings.tip-settings","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.tips.settings.v1.CreateDefaultTipSettingsRequest","responseMessage":"wix.tips.settings.v1.CreateDefaultTipSettingsResponse"},"legacyExamples":[{"name":"CreateDefaultTipSettings","serviceName":"TipSettingsService","type":"METHOD","content":{"title":"Create default tip settings","request":"curl -X POST \\\n'https://www.wixapis.com/tip-settings/v1/tip-settings/create-default' \\\n-H 'Authorization: ' \\\n-H 'Content-Type: application/json' \\\n-d '{\n \"tipSettings\": {\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10\n },\n {\n \"value\": 15\n }\n ],\n \"tipType\": \"PERCENTAGE\",\n \"allowCustomerTip\": false,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\"\n }\n}'","response":"{\n \"tipSettings\": {\n \"id\": \"1338729c-7255-48f1-a66e-f6a8e4b6f9f3\",\n \"tipType\": \"PERCENTAGE\",\n \"presets\": [\n {\n \"value\": 5,\n \"default\": true\n },\n {\n \"value\": 10,\n \"default\": null\n },\n {\n \"value\": 15,\n \"default\": null\n }\n ],\n \"allowCustomerTip\": false,\n \"allowBusinessTipAtPayment\": true,\n \"allowCustomAmount\": true,\n \"staffDistributionMethod\": \"PROPORTIONAL\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-09-23T08:16:35.039Z\",\n \"updatedDate\": \"2024-09-23T08:16:35.039Z\",\n \"default\": true,\n \"appId\": null,\n \"extendedFields\": null\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git","contentLink":{"displayName":"Create Default Tip Settings","slugifiedName":"create-default-tip-settings"},"permissionScopes":[{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"}],"isAdminMethod":true},{"summary":"Delete Tip Settings","description":"Deletes a `tipSettings` object.\n\n\nYou can't delete the default `tipSettings` object.","operationId":"wix.tips.settings.v1.TipSettingsService.DeleteTipSettings","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"tipSettingsId","description":"ID of the `tipSettings` object to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.tips.settings.v1.DeleteTipSettingsResponse","description":""}},"deprecated":false,"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.tips.settings.v1.TipSettingsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_DELETE_DEFAULT_SETTINGS","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CANNOT_DELETE_DEFAULT_SETTINGS"}}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_TIPS.TIP_SETTINGS_DELETE"],"protoArtifactId":"com.wixpress.tips.settings:tip-settings","serviceArtifactId":"com.wixpress.tips.settings.tip-settings","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.tips.settings.v1.DeleteTipSettingsRequest","responseMessage":"wix.tips.settings.v1.DeleteTipSettingsResponse"},"legacyExamples":[{"name":"DeleteTipSettings","serviceName":"TipSettingsService","type":"METHOD","content":{"title":"Delete tip settings","request":"curl -X DELETE \\\n'https://www.wixapis.com/tip-settings/v1/tip-settings/1338729c-7255-48f1-a66e-f6a8e4b6f9f3' \\\n-H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git"},"httpMethod":"delete","path":"/v1/tip-settings/{tipSettingsId}","rpcOnly":false,"servers":[{"url":"https://manage.wix.com/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://_/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"_","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://*.dev.wix-code.com/_api/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tip-settings","destinationPath":"","url":"*.dev.wix-code.com","serviceName":"wix.tips.settings.v1.TipSettingsService"}},{"url":"https://www.wixapis.com/tip-settings","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/tip-settings","destinationPath":"","url":"www.wixapis.com","serviceName":"wix.tips.settings.v1.TipSettingsService"}}],"triggeredEvents":[],"serviceName":"wix.tips.settings.v1.TipSettingsService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_DELETE_DEFAULT_SETTINGS","errorType":"APPLICATION","applicationCodeData":{"applicationCode":"CANNOT_DELETE_DEFAULT_SETTINGS"}}],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_TIPS.TIP_SETTINGS_DELETE"],"protoArtifactId":"com.wixpress.tips.settings:tip-settings","serviceArtifactId":"com.wixpress.tips.settings.tip-settings","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.tips.settings.v1.DeleteTipSettingsRequest","responseMessage":"wix.tips.settings.v1.DeleteTipSettingsResponse"},"legacyExamples":[{"name":"DeleteTipSettings","serviceName":"TipSettingsService","type":"METHOD","content":{"title":"Delete tip settings","request":"curl -X DELETE \\\n'https://www.wixapis.com/tip-settings/v1/tip-settings/1338729c-7255-48f1-a66e-f6a8e4b6f9f3' \\\n-H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git","contentLink":{"displayName":"Delete Tip Settings","slugifiedName":"delete-tip-settings"},"permissionScopes":[{"name":"Manage Bookings - all permissions","scopeId":"SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS"},{"name":"Manage Bookings","scopeId":"SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS"}],"isAdminMethod":true}],"webhooks":[],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Tips Settings API\n\nThe Tips Settings API allows app developers to manage how Wix Tips calculates\ntips and distributes them among staff.\n\nWith the Tips Settings API, your app can:\n\n- Update a site's default tip settings.\n- Manage non-default tips settings.\n\nSee also:\n+ [Tips API](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tips/introduction)\n+ [Tippable Staff API](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tippable-staff/introduction)\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n+ Ensure that the site owner has installed [Wix Tips](fallback::https://www.wix.com/app-market/wix-tips)\n on their site.\n+ You can't delete the default tip settings that Wix Tips automatically creates\n upon installation, but you can update them.\n+ For each `tipSettings` object, you can configure up to 3 preset tip choices\n that Wix Tips displays to customers during the\n [eCommerce checkout](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).\n Additionally, you can allow customers to manually enter a custom tip amount.\n\n## Sample Use Cases\n\n- [Create location-specific tip settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/sample-flows#create-location-specific-tip-settings).\n- [Allow business owners to add a tip calculated from a tip settings for a location on behalf of the customer](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/sample-flows#allow-business-owners-to-add-a-tip-calculated-from-a-tip-settings-for-a-location-on-behalf-of-the-customer).\n\n## Terminology\n\n+ **Tip**: Details the tip amount, how it’s distributed among staff, and the\n associated order’s line item subtotal. Refer to the\n [Tips API](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tips/introduction)\n for more information.\n+ **Tip distribution**: How the total tip is allocated among eligible staff.\n You can split tips equally among staff or define proportional shares. The\n business receives the undistributed tip amount.\n+ **Tip settings**: Allow you to customize how Wix Tips previews and calculates\n tips based on various factors; including\n [business location](fallback::https://dev.wix.com/docs/rest/business-management/locations/introduction),\n external payment terminal used for the\n [eCommerce checkout](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction),\n product or service being purchased or which\n [site collaborator](fallback::https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site)\n manages the payment process via the site's dashboard.\n+ **Staff**: Team members receiving a portion of the tip. Currently, only\n [Bookings staff members](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction)\n and [site collaborators](fallback::https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site)\n are eligible to receive tip distributions. Refer to the\n [Tippable Staff API](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tippable-staff/introduction)\n for more information.\n","sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git","path":"proto/docs/guides/introduction.md"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Tips Settings API: Sample Use Cases and Flows\n\nThis article shares basic flows your app could support.\nYou're certainly not limited to these use cases, but they can be a helpful jumping-off point for your planning.\n\n## Create location-specific tip settings\n\nYour app could create tip settings tailored to a specific\n[location](fallback::https://dev.wix.com/docs/rest/business-management/locations/introduction).\n\nTo create location-specific tip settings:\n\n1. Use [List Locations](fallback::https://dev.wix.com/docs/rest/business-management/locations/list-locations)\n to retrieve a list of all locations associated with the site.\n1. Display the list of locations to the business owners and allow them select\n the location for which they want to configure specific tip settings.\n1. Check if tip settings already exist for the chosen location using\n [Query Tip Settings](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ec282ae5-4a5d-4d95-aedb-147dcc90e28eslug::query-tip-settings*fallback::https://dev.wix.com/docs/rest/internal-only/tips/tip-settings/query-tip-settings).\n Filter the query by the relevant location ID.\n1. If location-specific tip settings exist, display them to the business\n owners for review and editing. If no settings exist, display default values\n and allow customization.\n1. Save the tip settings using either\n [Create Tip Settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/create-tip-settings),\n (for new settings) or\n [Update Tip Settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/create-tip-settings)\n (for existing settings).\n\n## Create payment-terminal-specific tip settings\n\nYour app could create tip settings tailored to a specific device used for processing payments.\n\nTo create payment-terminal-specific tip settings:\n\n1. Check if tip settings already exist for the relevant payment terminal using\n [Query Tip Settings](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ec282ae5-4a5d-4d95-aedb-147dcc90e28eslug::query-tip-settings*fallback::https://dev.wix.com/docs/rest/internal-only/tips/tip-settings/query-tip-settings).\n Provide `paymentTerminalId` as filter.\n1. If payment-terminal-specific tip settings exist, display them to the business\n owners for review and editing. If no settings exist, display default values\n and allow customization.\n1. Save the tip settings using either\n [Create Tip Settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/create-tip-settings),\n (for new settings) or\n [Update Tip Settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/create-tip-settings)\n (for existing settings).\n","sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git","path":"proto/docs/guides/sample-flows.md"},{"displayName":"Supported Filters","slugifyName":"supported-filters","content":"# Tip Settings: Supported Filters and Sorting\n\nQuery endpoints allow you to filter and sort results based on service properties.\nThis article covers field support for filtering and sorting.\n\nThe following table shows field support for filters and sorting\nfor the `tipSettings` object in\n[Query Tip Settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/query-tip-settings):\n\n| Field | Supported Filters | Sortable |\n| --------------- | --------------------------------------------- | -------- |\n| `id` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `tipType` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `locationId` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `paymentTerminalId` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `default` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `allowCustomerTip` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `allowBusinessTipAtPayment` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `allowCustomAmount` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n\n__Related content:__\n+ [API Query Language](fallback::https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)\n+ [Query Tip Settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/query-tip-settings)","sourceRepo":"git@github.com:wix-private/wix-vmr-repo.git","path":"proto/docs/guides/SupportedFilters.md"}],"components":{"schemas":{"wix.tips.settings.v1.TipSettings":{"type":"object","properties":{"id":{"description":"ID of the tip settings.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tipType":{"description":"Tip type.\n\nSupported values:\n+ `UNKNOWN_TIP_TYPE`: There is no information about the tip type.\n+ `PERCENTAGE`: The tip is calculated as a percentage of the subtotal for all related line items.\n+ `AMOUNT`: The tip is a fixed amount.","title":"tipType","type":"string","$ref":"#/components/schemas/wix.tips.settings.v1.TipType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"presets":{"description":"Information about the tip choices that Wix Tips displays to customers during the\n[eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).\n\nMin: `1` preset\nMax: `3` presets","minItems":1,"maxItems":3,"title":"presets","type":"array","items":{"$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings.Preset"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowCustomerTip":{"description":"Whether customer are allowed to tip during the\n[eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).\n\nDefault: `true`","title":"allowCustomerTip","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowBusinessTipAtPayment":{"description":"Whether the business owners are given the option to add a tip during the\npayment collection flow in their dashboard.\n\nDefault: `true`","title":"allowBusinessTipAtPayment","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowCustomAmount":{"description":"Whether customers can enter a custom tip amount. If set to `false`, customers\ncan only select a tip value from the available `presets` and can't enter a\ncustom amount.\n\nDefault: `true`","title":"allowCustomAmount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowEditDistribution":{"description":"Whether business owners are allowed to edit tip distributions. If set to\n`false`, owners can't edit distributions after they were created.\n\nDefault: `true`","title":"allowEditDistribution","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"staffDistributionMethod":{"description":"How the tip is distributed among staff.\n\nSupported values:\n`UNKNOWN_SPLIT_METHOD`: There is no information about the staff distribution method.\n`EQUAL`: The tip is distributed equally among all staff.\n`PROPORTIONAL`: The tip is distributed proportionally among staff.","title":"staffDistributionMethod","type":"string","$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings.StaffDistributionMethod","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time `tipSettings` object is\nupdated. To prevent conflicting changes, the current revision must be passed\nwhen updating `tipSettings`. Ignored when creating a `tipSettings` object.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the tip settings were created in\n`YYYY-MM-DDThh:mm:ss.sssZ` format.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the tip settings were last updated\n`YYYY-MM-DDThh:mm:ss.sssZ` format.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"default":{"description":"Whether these are the default tip settings. Wix Tips automatically creates\nthe default settings during the app's installation. You can't delete these\ndefault settings but you can update them. Wix Tips uses the default settings\nto calculate tips, unless you specify other settings.","readOnly":true,"title":"default","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of the app that has created the settings. See the list of app IDs for\n[Wix business solutions](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions).","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"extendedFields":{"description":"Custom field data for the `tipSettings` object. Extended fields must be\nconfigured in the app dashboard before they can be accessed with API calls.","$ref":"#/components/schemas/wix.common.data.dataextensions.ExtendedFields","summary":"extendedFields","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TipSettings","description":"Tip settings define how tips are calculated and distributed among staff. When\nWix Tips is installed, default settings are automatically created. You can't\ndelete these default settings but you can update them. Creating additional\nsettings allows business owners to customize tip screens for different payment\nterminals or set specific presets for various products or services.","oneOf":[{"description":"","summary":"identifier","$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings.identifier"}]},"wix.tips.settings.v1.TipSettings.identifier":{"type":"object","title":"identifier","properties":{"locationId":{"description":"ID of the [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)\nfor which the tip settings apply.","format":"GUID","title":"locationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paymentTerminalId":{"description":"ID of the payment terminal for which the tip settings apply. Wix Tips doesn't\nvalidate the ID you provide.\n\nMax: 30 characters","maxLength":30,"title":"paymentTerminalId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"userId":{"description":"ID of the Wix user for whom the tip settings apply. For example, the site owner or a\n[site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).","format":"GUID","title":"userId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.FloatValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"float","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FloatValue","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"wix.tips.settings.v1.TipType":{"type":"string","description":"","title":"TipType","enum":[{"order":0,"value":"UNKNOWN_TIP_TYPE","description":"There is no information about the tip type.","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"PERCENTAGE","description":"The tip is calculated as a percentage of the subtotal of all related line items.","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"AMOUNT","description":"The tip is a fixed amount.","maturity":"GA","exposure":"PUBLIC"}]},"wix.tips.settings.v1.TipSettings.Preset":{"type":"object","properties":{"value":{"description":"Value of the preset tip choice that's displayed to customers in the\n[eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).\nFor example, `5`, `10`, and `15` percent or `1`, `3`, and `5` USD.\n\nMin: `0`","minimum":0,"title":"value","$ref":"#/components/schemas/google.protobuf.FloatValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"default":{"description":"Whether this tip choice value is the dafault preset that's highlighted automatically in the\n[eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).\n\nDefault: `false`","title":"default","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Preset","description":""},"wix.tips.settings.v1.TipSettings.StaffDistributionMethod":{"type":"string","description":"","title":"StaffDistributionMethod","enum":[{"order":0,"value":"UNKNOWN_SPLIT_METHOD","description":"There is no information about the staff distribution method.","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"EQUAL","description":"All staff receive an equal amount of the tip.","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"PROPORTIONAL","description":"Staff receive a proportional amount of the tip.","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","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":""},"wix.common.data.dataextensions.ExtendedFields":{"type":"object","properties":{"namespaces":{"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).","title":"namespaces","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Struct"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExtendedFields","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":[{"order":0,"value":"NULL_VALUE","description":"","maturity":"GA","exposure":"PUBLIC"}]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.tips.settings.v1.QueryTipSettingsRequest":{"type":"object","properties":{"query":{"description":"WQL expression","$ref":"#/components/schemas/wix.tips.settings.v1.upstream.wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryTipSettingsRequest","description":""},"wix.tips.settings.v1.upstream.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\"}]`","maxItems":10,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.tips.settings.v1.upstream.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.","maxLength":200,"maxItems":10,"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.","maxLength":200,"maxItems":10,"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.tips.settings.v1.upstream.wix.common.QueryV2.pagingMethod"}]},"wix.tips.settings.v1.upstream.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.tips.settings.v1.upstream.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.tips.settings.v1.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.tips.settings.v1.upstream.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.tips.settings.v1.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.tips.settings.v1.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":[{"order":0,"value":"ASC","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"DESC","description":"","maturity":"GA","exposure":"PUBLIC"}]},"wix.tips.settings.v1.upstream.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":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"wix.tips.settings.v1.upstream.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":""},"wix.tips.settings.v1.QueryTipSettingsResponse":{"type":"object","properties":{"tipSettings":{"description":"Retrieved `tipSettings` objects.","title":"tipSettings","type":"array","items":{"$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Metadate for the paged set of retrieved `tipSettings` objects.","$ref":"#/components/schemas/wix.tips.settings.v1.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryTipSettingsResponse","description":""},"wix.tips.settings.v1.upstream.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.tips.settings.v1.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"wix.tips.settings.v1.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"wix.tips.settings.v1.UpdateTipSettingsRequest":{"type":"object","properties":{"tipSettings":{"description":"Tip settings to update.","$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings","summary":"tipSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTipSettingsRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"wix.tips.settings.v1.UpdateTipSettingsResponse":{"type":"object","properties":{"tipSettings":{"description":"Updated tip settings.","$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings","summary":"tipSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTipSettingsResponse","description":""},"wix.tips.settings.v1.CreateTipSettingsRequest":{"type":"object","properties":{"tipSettings":{"description":"Tip settings to create.","$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings","summary":"tipSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateTipSettingsRequest","description":""},"wix.tips.settings.v1.CreateTipSettingsResponse":{"type":"object","properties":{"tipSettings":{"description":"Created tip settings.","$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings","summary":"tipSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateTipSettingsResponse","description":""},"wix.tips.settings.v1.CreateDefaultTipSettingsRequest":{"type":"object","properties":{"tipSettings":{"description":"Dafault tip settings to create.","$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings","summary":"tipSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateDefaultTipSettingsRequest","description":""},"wix.tips.settings.v1.CreateDefaultTipSettingsResponse":{"type":"object","properties":{"tipSettings":{"description":"Created default tip settings.","$ref":"#/components/schemas/wix.tips.settings.v1.TipSettings","summary":"tipSettings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateDefaultTipSettingsResponse","description":""},"wix.tips.settings.v1.DeleteTipSettingsRequest":{"type":"object","properties":{"tipSettingsId":{"description":"ID of the `tipSettings` object to delete.","format":"GUID","title":"tipSettingsId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteTipSettingsRequest","description":""},"wix.tips.settings.v1.DeleteTipSettingsResponse":{"type":"object","properties":{},"title":"DeleteTipSettingsResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"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":[{"order":0,"value":"UNKNOWN","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":1,"value":"ANONYMOUS_VISITOR","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":2,"value":"MEMBER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":3,"value":"WIX_USER","description":"","maturity":"GA","exposure":"PUBLIC"},{"order":4,"value":"APP","description":"","maturity":"GA","exposure":"PUBLIC"}]}}},"title":"Tip Settings","description":"Tip settings define how tips are calculated and distributed among staff. When\nWix Tips is installed, default settings are automatically created. You can't\ndelete these default settings but you can update them. Creating additional\nsettings allows business owners to customize tip screens for different payment\nterminals or set specific presets for various products or services.","fqdn":"wix.tips.settings.v1.tip_settings"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Tips Settings API\n\nThe Tips Settings API allows app developers to manage how Wix Tips calculates\ntips and distributes them among staff.\n\nWith the Tips Settings API, your app can:\n\n- Update a site's default tip settings.\n- Manage non-default tips settings.\n\nSee also:\n+ [Tips API](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tips/introduction)\n+ [Tippable Staff API](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tippable-staff/introduction)\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n+ Ensure that the site owner has installed [Wix Tips](fallback::https://www.wix.com/app-market/wix-tips)\n on their site.\n+ You can't delete the default tip settings that Wix Tips automatically creates\n upon installation, but you can update them.\n+ For each `tipSettings` object, you can configure up to 3 preset tip choices\n that Wix Tips displays to customers during the\n [eCommerce checkout](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/checkout-object).\n Additionally, you can allow customers to manually enter a custom tip amount.\n\n## Sample Use Cases\n\n- [Create location-specific tip settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/sample-flows#create-location-specific-tip-settings).\n- [Allow business owners to add a tip calculated from a tip settings for a location on behalf of the customer](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/sample-flows#allow-business-owners-to-add-a-tip-calculated-from-a-tip-settings-for-a-location-on-behalf-of-the-customer).\n\n## Terminology\n\n+ **Tip**: Details the tip amount, how it’s distributed among staff, and the\n associated order’s line item subtotal. Refer to the\n [Tips API](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tips/introduction)\n for more information.\n+ **Tip distribution**: How the total tip is allocated among eligible staff.\n You can split tips equally among staff or define proportional shares. The\n business receives the undistributed tip amount.\n+ **Tip settings**: Allow you to customize how Wix Tips previews and calculates\n tips based on various factors; including\n [business location](fallback::https://dev.wix.com/docs/rest/business-management/locations/introduction),\n external payment terminal used for the\n [eCommerce checkout](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction),\n product or service being purchased or which\n [site collaborator](fallback::https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site)\n manages the payment process via the site's dashboard.\n+ **Staff**: Team members receiving a portion of the tip. Currently, only\n [Bookings staff members](fallback::https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction)\n and [site collaborators](fallback::https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site)\n are eligible to receive tip distributions. Refer to the\n [Tippable Staff API](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tippable-staff/introduction)\n for more information.\n"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Tips Settings API: Sample Use Cases and Flows\n\nThis article shares basic flows your app could support.\nYou're certainly not limited to these use cases, but they can be a helpful jumping-off point for your planning.\n\n## Create location-specific tip settings\n\nYour app could create tip settings tailored to a specific\n[location](fallback::https://dev.wix.com/docs/rest/business-management/locations/introduction).\n\nTo create location-specific tip settings:\n\n1. Use [List Locations](fallback::https://dev.wix.com/docs/rest/business-management/locations/list-locations)\n to retrieve a list of all locations associated with the site.\n1. Display the list of locations to the business owners and allow them select\n the location for which they want to configure specific tip settings.\n1. Check if tip settings already exist for the chosen location using\n [Query Tip Settings](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ec282ae5-4a5d-4d95-aedb-147dcc90e28eslug::query-tip-settings*fallback::https://dev.wix.com/docs/rest/internal-only/tips/tip-settings/query-tip-settings).\n Filter the query by the relevant location ID.\n1. If location-specific tip settings exist, display them to the business\n owners for review and editing. If no settings exist, display default values\n and allow customization.\n1. Save the tip settings using either\n [Create Tip Settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/create-tip-settings),\n (for new settings) or\n [Update Tip Settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/create-tip-settings)\n (for existing settings).\n\n## Create payment-terminal-specific tip settings\n\nYour app could create tip settings tailored to a specific device used for processing payments.\n\nTo create payment-terminal-specific tip settings:\n\n1. Check if tip settings already exist for the relevant payment terminal using\n [Query Tip Settings](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::ec282ae5-4a5d-4d95-aedb-147dcc90e28eslug::query-tip-settings*fallback::https://dev.wix.com/docs/rest/internal-only/tips/tip-settings/query-tip-settings).\n Provide `paymentTerminalId` as filter.\n1. If payment-terminal-specific tip settings exist, display them to the business\n owners for review and editing. If no settings exist, display default values\n and allow customization.\n1. Save the tip settings using either\n [Create Tip Settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/create-tip-settings),\n (for new settings) or\n [Update Tip Settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/create-tip-settings)\n (for existing settings).\n"},{"displayName":"Supported Filters","slugifyName":"supported-filters","content":"# Tip Settings: Supported Filters and Sorting\n\nQuery endpoints allow you to filter and sort results based on service properties.\nThis article covers field support for filtering and sorting.\n\nThe following table shows field support for filters and sorting\nfor the `tipSettings` object in\n[Query Tip Settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/query-tip-settings):\n\n| Field | Supported Filters | Sortable |\n| --------------- | --------------------------------------------- | -------- |\n| `id` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `tipType` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `locationId` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `paymentTerminalId` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `default` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `allowCustomerTip` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `allowBusinessTipAtPayment` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n| `allowCustomAmount` | `$eq`, `$ne`, `$in`, `$exists` | Sortable |\n\n__Related content:__\n+ [API Query Language](fallback::https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)\n+ [Query Tip Settings](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/tips/tip-settings/query-tip-settings)"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}