{"id":"2007fd47-2f19-4122-97d7-7ef97ece3ca5","createdDate":"2024-03-14T10:34:40.049Z","updatedDate":"2024-03-14T10:34:40.049Z","resourceId":"fc9af0f0-4ce4-4684-840f-eb512678223f","api":{"schema":{"object":{"displayName":"Rule Object","description":"A rule defines the fee that is applied when specific conditions (also defined by the rule) are met. You can use a rule to apply a service fee to a restaurant order.","slug":"rule-object","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","legacyExamples":[{"title":"Rule","content":"{\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n }\n}\n"},{"title":"Rule","content":"{\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n }\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"methods":[{"summary":"Calculate Service Fees","description":"Calculates service fees for an order.\n\nThe specified order information is evaluated against all rules created for the site. If the rule conditions are met, the service fee set in the rule is applied. Otherwise, no service fee is added.","operationId":"com.wixpress.service.fees.v1.ServiceFeesCalculate.CalculateServiceFees","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.CalculateServiceFeesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/service-fees/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/service-fees/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CalculateServiceFeesRequest","description":"","properties":{"order":{"description":"Order information needed to evaluate the rules and calculate the relevant fees.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}},"label":{"description":"DEPRECATED. Defines the app that the rule is connected to.","maxLength":100,"minLength":1,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"DEPRECATED. Defines the app that the rule is connected to.","replacedBy":"app_id","targetRemovalDate":"2023-02-19"}}},"appId":{"description":"Defines the app that the rule is connected to.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["order","order.currency","order.priceSummary"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesCalculate","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_READ"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.CalculateServiceFeesRequest","responseMessage":"com.wixpress.service.fees.v1.CalculateServiceFeesResponse"},"legacyExamples":[{"name":"CalculateServiceFees","type":"METHOD","content":{"title":"Calculate service fees","request":"curl -X POST https://www.wixapis.com/service-fees-rules/v1/calculate \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"order\": {\n \"shippingInfo\": {\n \"logistics\": {\n \"type\": \"PICKUP\"\n }\n },\n \"platform\": {\n \"value\": \"SITE\"\n },\n \"priceSummary\": {\n \"subtotal\": \"10\"\n },\n \"currency\": \"USD\"\n }\n}'","response":"{\n \"calculatedFees\": [\n {\n \"ruleId\": \"a71ec83c-a705-4da4-8e70-237b7d7b838d\",\n \"name\": \"Rule 1\",\n \"fee\": {\n \"value\": \"10.00\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"tax\": null,\n \"taxGroupId\": null\n },\n {\n \"ruleId\": \"bedea267-4b42-4727-b74a-9a8db48fd6db\",\n \"name\": \"2\",\n \"fee\": {\n \"value\": \"23.00\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"tax\": null,\n \"taxGroupId\": null\n },\n {\n \"ruleId\": \"d84423ac-f73d-44a9-9ffb-f36fb163dc6b\",\n \"name\": \"service fee 1\",\n \"fee\": {\n \"value\": \"11.00\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"tax\": null,\n \"taxGroupId\": null\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"post","path":"/v1/calculate","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesCalculate","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_READ"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.CalculateServiceFeesRequest","responseMessage":"com.wixpress.service.fees.v1.CalculateServiceFeesResponse"},"legacyExamples":[{"name":"CalculateServiceFees","type":"METHOD","content":{"title":"Calculate service fees","request":"curl -X POST https://www.wixapis.com/service-fees-rules/v1/calculate \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"order\": {\n \"shippingInfo\": {\n \"logistics\": {\n \"type\": \"PICKUP\"\n }\n },\n \"platform\": {\n \"value\": \"SITE\"\n },\n \"priceSummary\": {\n \"subtotal\": \"10\"\n },\n \"currency\": \"USD\"\n }\n}'","response":"{\n \"calculatedFees\": [\n {\n \"ruleId\": \"a71ec83c-a705-4da4-8e70-237b7d7b838d\",\n \"name\": \"Rule 1\",\n \"fee\": {\n \"value\": \"10.00\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"tax\": null,\n \"taxGroupId\": null\n },\n {\n \"ruleId\": \"bedea267-4b42-4727-b74a-9a8db48fd6db\",\n \"name\": \"2\",\n \"fee\": {\n \"value\": \"23.00\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"tax\": null,\n \"taxGroupId\": null\n },\n {\n \"ruleId\": \"d84423ac-f73d-44a9-9ffb-f36fb163dc6b\",\n \"name\": \"service fee 1\",\n \"fee\": {\n \"value\": \"11.00\",\n \"currency\": \"EUR\",\n \"formattedValue\": null\n },\n \"tax\": null,\n \"taxGroupId\": null\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Calculate Service Fees","slugifiedName":"calculate-service-fees"},"permissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"List Rules","description":"Retrieves an array of all rules.\n\n\nYou can filter by location or app that the rules are associated with.","operationId":"com.wixpress.service.fees.v1.ServiceFeesRules.ListRules","parameters":[{"name":"locationId","in":"query","description":"Retrieve only rule that apply at the [location](https://dev.wix.com/docs/rest/api-reference/business-tools/locations/location-object) with this ID. If this field is `null`, the rules will not be filtered by location.","required":false,"schema":{"description":"Retrieve only rule that apply at the [location](https://dev.wix.com/docs/rest/api-reference/business-tools/locations/location-object) with this ID. If this field is `null`, the rules will not be filtered by location.","format":"GUID","title":"locationId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"label","in":"query","description":"DEPRECATED. Defines the app that the rule is connected to.","required":false,"schema":{"description":"DEPRECATED. Defines the app that the rule is connected to.","maxLength":100,"minLength":1,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"DEPRECATED. Defines the app that the rule is connected to.","replacedBy":"app_id","targetRemovalDate":"2023-02-19"}}}},{"name":"appId","in":"query","description":"Defines the app that the rule is connected to.","required":false,"schema":{"description":"Defines the app that the rule is connected to.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.ListRulesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/service-fees/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/service-fees/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_READ"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.ListRulesRequest","responseMessage":"com.wixpress.service.fees.v1.ListRulesResponse"},"legacyExamples":[{"name":"ListRules","type":"METHOD","content":{"title":"List rules associated with a specific location and specific app","request":"curl -X GET https://www.wixapis.com/service-fees-rules/v1/rules \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"locationId\": \"d84423ab-f73d-44a9-9ffb-f36fb163dc6b\",\n \"appId\": \"d84429ab-f73d-44a9-9ffb-f36fb163dc6b\"\n}'","response":"{\n \"rules\": [\n {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n },\n \"locationId\": \"d84423ab-f73d-44a9-9ffb-f36fb163dc6b\"\n },\n {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\",\n \"locationId\": \"d84423ab-f73d-44a9-9ffb-f36fb163dc6b\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"get","path":"/v1/rules","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_READ"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.ListRulesRequest","responseMessage":"com.wixpress.service.fees.v1.ListRulesResponse"},"legacyExamples":[{"name":"ListRules","type":"METHOD","content":{"title":"List rules associated with a specific location and specific app","request":"curl -X GET https://www.wixapis.com/service-fees-rules/v1/rules \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"locationId\": \"d84423ab-f73d-44a9-9ffb-f36fb163dc6b\",\n \"appId\": \"d84429ab-f73d-44a9-9ffb-f36fb163dc6b\"\n}'","response":"{\n \"rules\": [\n {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n },\n \"locationId\": \"d84423ab-f73d-44a9-9ffb-f36fb163dc6b\"\n },\n {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\",\n \"locationId\": \"d84423ab-f73d-44a9-9ffb-f36fb163dc6b\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"List Rules","slugifiedName":"list-rules"},"permissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Create Rule","description":"Creates a rule.\n\n\nTo create multiple rules at once, use [Bulk Create Rules](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/rules/bulk-create-rules).\n\nRead more about [constructing a rule](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/rules/constructing-a-rule).","operationId":"com.wixpress.service.fees.v1.ServiceFeesRules.CreateRule","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.CreateRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/service-fees/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/service-fees/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateRuleRequest","description":"","properties":{"rule":{"description":"Rule to create.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","summary":"rule","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["rule","rule.name","rule.enabled"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Rule Created","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_created","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_CREATE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.CreateRuleRequest","responseMessage":"com.wixpress.service.fees.v1.CreateRuleResponse"},"legacyExamples":[{"name":"CreateRule","type":"METHOD","order":1,"content":{"title":"Create rule with a fixed fee","request":"curl -X POST https://www.wixapis.com/service-fees-rules/v1/rules \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"rule\": {\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n }\n }\n}'","response":"{\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n }\n }\n}"}},{"name":"CreateRule","type":"METHOD","order":2,"content":{"title":"Create rule with percentage fee","request":"curl -X POST https://www.wixapis.com/service-fees-rules/v1/rules \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"rule\": {\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n }\n}'","response":"{\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"post","path":"/v1/rules","rpcOnly":false,"triggeredEvents":[{"title":"Rule Created","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_created","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_CREATE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.CreateRuleRequest","responseMessage":"com.wixpress.service.fees.v1.CreateRuleResponse"},"legacyExamples":[{"name":"CreateRule","type":"METHOD","order":1,"content":{"title":"Create rule with a fixed fee","request":"curl -X POST https://www.wixapis.com/service-fees-rules/v1/rules \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"rule\": {\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n }\n }\n}'","response":"{\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n }\n }\n}"}},{"name":"CreateRule","type":"METHOD","order":2,"content":{"title":"Create rule with percentage fee","request":"curl -X POST https://www.wixapis.com/service-fees-rules/v1/rules \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"rule\": {\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n }\n}'","response":"{\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Create Rule","slugifiedName":"create-rule"},"permissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Get Rule","description":"Retrieves a rule.","operationId":"com.wixpress.service.fees.v1.ServiceFeesRules.GetRule","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"ruleId","description":"ID of the rule to retrieve.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.GetRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/service-fees/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/service-fees/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_READ"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.GetRuleRequest","responseMessage":"com.wixpress.service.fees.v1.GetRuleResponse"},"legacyExamples":[{"name":"GetRule","type":"METHOD","content":{"title":"Get a rule","request":"curl -X GET https://www.wixapis.com/service-fees-rules/v1/rules/4aea505e-ac49-4f72-b4f1-b07c064a20cd \\\n -H 'Authorization: '","response":"{\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"get","path":"/v1/rules/{ruleId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_READ"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.GetRuleRequest","responseMessage":"com.wixpress.service.fees.v1.GetRuleResponse"},"legacyExamples":[{"name":"GetRule","type":"METHOD","content":{"title":"Get a rule","request":"curl -X GET https://www.wixapis.com/service-fees-rules/v1/rules/4aea505e-ac49-4f72-b4f1-b07c064a20cd \\\n -H 'Authorization: '","response":"{\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Get Rule","slugifiedName":"get-rule"},"permissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Delete Rule","description":"Deletes a rule.\n\n\nTo delete mutiple rules at once, use [Bulk Delete Rules](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/rules/bulk-delete-rules).","operationId":"com.wixpress.service.fees.v1.ServiceFeesRules.DeleteRule","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"ruleId","description":"ID of the rule to delete.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.DeleteRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/service-fees/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/service-fees/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Rule Deleted","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_deleted","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_DELETE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.DeleteRuleRequest","responseMessage":"com.wixpress.service.fees.v1.DeleteRuleResponse"},"legacyExamples":[{"name":"DeleteRule","type":"METHOD","content":{"title":"Delete a rule","request":"curl -X DELETE https://www.wixapis.com/service-fees-rules/v1/rules/4aea505e-ac49-4f72-b4f1-b07c064a20cd \\\n -H 'Authorization: '","response":"{"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"delete","path":"/v1/rules/{ruleId}","rpcOnly":false,"triggeredEvents":[{"title":"Rule Deleted","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_deleted","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_DELETE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.DeleteRuleRequest","responseMessage":"com.wixpress.service.fees.v1.DeleteRuleResponse"},"legacyExamples":[{"name":"DeleteRule","type":"METHOD","content":{"title":"Delete a rule","request":"curl -X DELETE https://www.wixapis.com/service-fees-rules/v1/rules/4aea505e-ac49-4f72-b4f1-b07c064a20cd \\\n -H 'Authorization: '","response":"{"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Delete Rule","slugifiedName":"delete-rule"},"permissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Update Rule","description":"Updates a rule.\n\nEach time the task is updated, `revision` increments by 1. The existing `revision` must be included when updating the task. This ensures you're working with the latest task and prevents unintended overwrites.\n\nTo update multiple rules at once, use [Bulk Update Rules](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/rules/bulk-update-rules).","operationId":"com.wixpress.service.fees.v1.ServiceFeesRules.UpdateRule","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"rule.id","description":"Rule ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.UpdateRuleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/service-fees/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/service-fees/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateRuleRequest","description":"","properties":{"rule":{"description":"Rule to update.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","summary":"rule","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["rule","rule.id","rule.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Rule Updated","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_updated","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_UPDATE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.UpdateRuleRequest","responseMessage":"com.wixpress.service.fees.v1.UpdateRuleResponse"},"legacyExamples":[{"name":"UpdateRule","type":"METHOD","content":{"title":"Update a rule","request":"curl -X PATCH https://www.wixapis.com/service-fees-rules/v1/rules/update \\\n-H 'Content-Type: application/json;charset=UTF-8' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"rule\": {\n \"revision\": \"5\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n },\n \"mask\": {\n \"paths\": [\n \"name\",\n \"taxRate\",\n \"conditionType\",\n \"enabled\",\n \"roundingStrategy\",\n \"customTaxRate\",\n \"conditionOptions\",\n \"percentageFee\"\n ]\n }\n}'","response":"{\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"6\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"patch","path":"/v1/rules/{rule.id}","rpcOnly":false,"triggeredEvents":[{"title":"Rule Updated","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_updated","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_UPDATE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.UpdateRuleRequest","responseMessage":"com.wixpress.service.fees.v1.UpdateRuleResponse"},"legacyExamples":[{"name":"UpdateRule","type":"METHOD","content":{"title":"Update a rule","request":"curl -X PATCH https://www.wixapis.com/service-fees-rules/v1/rules/update \\\n-H 'Content-Type: application/json;charset=UTF-8' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"rule\": {\n \"revision\": \"5\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n },\n \"mask\": {\n \"paths\": [\n \"name\",\n \"taxRate\",\n \"conditionType\",\n \"enabled\",\n \"roundingStrategy\",\n \"customTaxRate\",\n \"conditionOptions\",\n \"percentageFee\"\n ]\n }\n}'","response":"{\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"6\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Update Rule","slugifiedName":"update-rule"},"permissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Query Rules","description":"Retrieves a list of rules, given the provided paging, filtering, and sorting.\n\nFor field support for filters and sorting,\nsee [Service Fees: Supported Filters and Sorting](/supported-filters-and-sorting).\n\nQuery Rules runs with these defaults, which you can override:\n- `cursorPaging.limit` is `50`\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/pagination),\nand [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).","operationId":"com.wixpress.service.fees.v1.ServiceFeesRules.QueryRules","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.QueryRulesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/service-fees/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/service-fees/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryRulesRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.upstream.wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["query"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_READ"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.QueryRulesRequest","responseMessage":"com.wixpress.service.fees.v1.QueryRulesResponse"},"legacyExamples":[{"name":"QueryRules","type":"METHOD","content":{"title":"Query rules with filter and sort","request":"curl -X GET https://www.wixapis.com/service-fees-rules/v1/rules \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"query\": {\n \"sort\": [\n {\n \"fieldName\": \"enabled\",\n \"order\": \"ASC\"\n }\n ],\n \"filter\": {\n \"name\": \"rule_name\"\n }\n }\n}'","response":"{\n \"rules\": [\n {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n },\n \"locationId\": \"d84423ab-f73d-44a9-9ffb-f36fb163dc6b\"\n },\n {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\",\n \"locationId\": \"d84423ab-f73d-44a9-9ffb-f36fb163dc6b\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"post","path":"/v1/rules/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_READ"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.QueryRulesRequest","responseMessage":"com.wixpress.service.fees.v1.QueryRulesResponse"},"legacyExamples":[{"name":"QueryRules","type":"METHOD","content":{"title":"Query rules with filter and sort","request":"curl -X GET https://www.wixapis.com/service-fees-rules/v1/rules \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"query\": {\n \"sort\": [\n {\n \"fieldName\": \"enabled\",\n \"order\": \"ASC\"\n }\n ],\n \"filter\": {\n \"name\": \"rule_name\"\n }\n }\n}'","response":"{\n \"rules\": [\n {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n },\n \"locationId\": \"d84423ab-f73d-44a9-9ffb-f36fb163dc6b\"\n },\n {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\",\n \"locationId\": \"d84423ab-f73d-44a9-9ffb-f36fb163dc6b\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Query Rules","slugifiedName":"query-rules"},"permissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Bulk Create Rules","description":"Bulk creates rules.\n\n\nTo create only one rule, use [Create Rule](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/rules/create-rule).\n\nRead more about [constructing a rule](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/rules/constructing-a-rule).","operationId":"com.wixpress.service.fees.v1.ServiceFeesRules.BulkCreateRules","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.BulkCreateRulesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/service-fees/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/service-fees/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkCreateRulesRequest","description":"","properties":{"rules":{"description":"Rules to create.","title":"rules","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule"},"x-wix-docs":{"exposure":"PUBLIC"}},"returnFullEntity":{"description":"Whether the full rule entity is returned.\n\nDefault: `false`.","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["rules"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Rule Created","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_created","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_CREATE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.BulkCreateRulesRequest","responseMessage":"com.wixpress.service.fees.v1.BulkCreateRulesResponse"},"legacyExamples":[{"name":"BulkCreateRules","type":"METHOD","order":1,"content":{"title":"Bulk create two rules","request":"curl -X POST https://www.wixapis.com/service-fees-rules/v1/rules/create \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"rules\": [\n {\n \"name\": \"rule_name\",\n \"tax_rate\": \"21.9\",\n \"condition_type\": \"CONDITION\",\n \"enabled\": true,\n \"rounding_strategy\": \"HALF_UP\",\n \"custom_tax_rate\": \"20\",\n \"condition_options\": {\n \"order_field_path\": \"priceSummary.subtotal\",\n \"expected_field_type\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixed_fee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n }\n },\n {\n \"name\": \"rule_name\",\n \"tax_rate\": \"12.9\",\n \"condition_type\": \"CONDITION\",\n \"enabled\": false,\n \"rounding_strategy\": \"HALF_EVEN\",\n \"custom_tax_rate\": \"11\",\n \"condition_options\": {\n \"order_field_path\": \"priceSummary.subtotal\",\n \"expected_field_type\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentage_fee\": \"11.9\"\n }\n ],\n \"return_full_entity\": true\n}'","response":"{\n \"results\": [\n {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n }\n },\n {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"post","path":"/v1/bulk/rules/create","rpcOnly":false,"triggeredEvents":[{"title":"Rule Created","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_created","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_CREATE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.BulkCreateRulesRequest","responseMessage":"com.wixpress.service.fees.v1.BulkCreateRulesResponse"},"legacyExamples":[{"name":"BulkCreateRules","type":"METHOD","order":1,"content":{"title":"Bulk create two rules","request":"curl -X POST https://www.wixapis.com/service-fees-rules/v1/rules/create \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"rules\": [\n {\n \"name\": \"rule_name\",\n \"tax_rate\": \"21.9\",\n \"condition_type\": \"CONDITION\",\n \"enabled\": true,\n \"rounding_strategy\": \"HALF_UP\",\n \"custom_tax_rate\": \"20\",\n \"condition_options\": {\n \"order_field_path\": \"priceSummary.subtotal\",\n \"expected_field_type\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixed_fee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n }\n },\n {\n \"name\": \"rule_name\",\n \"tax_rate\": \"12.9\",\n \"condition_type\": \"CONDITION\",\n \"enabled\": false,\n \"rounding_strategy\": \"HALF_EVEN\",\n \"custom_tax_rate\": \"11\",\n \"condition_options\": {\n \"order_field_path\": \"priceSummary.subtotal\",\n \"expected_field_type\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentage_fee\": \"11.9\"\n }\n ],\n \"return_full_entity\": true\n}'","response":"{\n \"results\": [\n {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"21.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": true,\n \"roundingStrategy\": \"HALF_UP\",\n \"customTaxRate\": \"20\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"5.9\",\n \"operation\": \"GT\"\n }\n },\n \"fixedFee\": {\n \"value\": \"21.3\",\n \"currency\": \"USD\"\n }\n },\n {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"1\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Bulk Create Rules","slugifiedName":"bulk-create-rules"},"permissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Bulk Update Rules","description":"Bulk updates rules.\n\nEach time the task is updated, `revision` increments by 1. The existing `revision` must be included when updating the task. This ensures you're working with the latest task and prevents unintended overwrites.\n\nTo update a single rule, use [Update Rule](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/rules/update-rule).","operationId":"com.wixpress.service.fees.v1.ServiceFeesRules.BulkUpdateRules","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.BulkUpdateRulesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/service-fees/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/service-fees/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateRulesRequest","description":"","properties":{"rules":{"description":"Masked rules to update.","title":"rules","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.MaskedRule"},"x-wix-docs":{"exposure":"PUBLIC"}},"returnFullEntity":{"description":"Whether the full rule entity is returned.\n\nDefault: `false`.","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["rules"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Rule Updated","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_updated","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_UPDATE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.BulkUpdateRulesRequest","responseMessage":"com.wixpress.service.fees.v1.BulkUpdateRulesResponse"},"legacyExamples":[{"name":"BulkUpdateRules","type":"METHOD","content":{"title":"Bulk update rules","request":"curl -X PATCH https://www.wixapis.com/service-fees-rules/v1/rules/4aea505e-ac49-4f72-b4f1-b07c064a20cd \\\n-H 'Content-Type: application/json;charset=UTF-8' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"return_full_entity\": true,\n \"rules\":[\n {\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"5\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n },\n \"mask\": {\n \"paths\": [\n \"name\",\n \"taxRate\",\n \"conditionType\",\n \"enabled\",\n \"roundingStrategy\",\n \"customTaxRate\",\n \"conditionOptions\",\n \"percentageFee\"\n ]\n }\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"itemId\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"itemType\": \"RULE\"\n },\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"6\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"patch","path":"/v1/bulk/rules/update","rpcOnly":false,"triggeredEvents":[{"title":"Rule Updated","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_updated","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_UPDATE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.BulkUpdateRulesRequest","responseMessage":"com.wixpress.service.fees.v1.BulkUpdateRulesResponse"},"legacyExamples":[{"name":"BulkUpdateRules","type":"METHOD","content":{"title":"Bulk update rules","request":"curl -X PATCH https://www.wixapis.com/service-fees-rules/v1/rules/4aea505e-ac49-4f72-b4f1-b07c064a20cd \\\n-H 'Content-Type: application/json;charset=UTF-8' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"return_full_entity\": true,\n \"rules\":[\n {\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"5\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n },\n \"mask\": {\n \"paths\": [\n \"name\",\n \"taxRate\",\n \"conditionType\",\n \"enabled\",\n \"roundingStrategy\",\n \"customTaxRate\",\n \"conditionOptions\",\n \"percentageFee\"\n ]\n }\n }\n ]\n}'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"itemId\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"itemType\": \"RULE\"\n },\n \"rule\": {\n \"id\": \"4aea505e-ac49-4f72-b4f1-b07c064a20cd\",\n \"revision\": \"6\",\n \"createdDate\": \"2023-12-10T07:06:39.306Z\",\n \"updatedDate\": \"2023-12-10T07:06:39.306Z\",\n \"name\": \"rule_name\",\n \"taxRate\": \"12.9\",\n \"conditionType\": \"CONDITION\",\n \"enabled\": false,\n \"roundingStrategy\": \"HALF_EVEN\",\n \"customTaxRate\": \"11\",\n \"conditionOptions\": {\n \"orderFieldPath\": \"priceSummary.subtotal\",\n \"expectedFieldType\": \"NUMBER\",\n \"number\": {\n \"value\": \"10\",\n \"operation\": \"EQ\"\n }\n },\n \"percentageFee\": \"11.9\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Bulk Update Rules","slugifiedName":"bulk-update-rules"},"permissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Bulk Delete Rules","description":"Bulk deletes rules.\n\n\nTo delete a single rule, use [Delete Rule](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/rules/delete-rule).","operationId":"com.wixpress.service.fees.v1.ServiceFeesRules.BulkDeleteRules","parameters":[{"name":"ruleIds","in":"query","description":"IDs of the rules to delete.","required":true,"schema":{"description":"IDs of the rules to delete.","format":"GUID","title":"ruleIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.BulkDeleteRulesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/service-fees/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/service-fees/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Rule Deleted","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_deleted","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_DELETE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.BulkDeleteRulesRequest","responseMessage":"com.wixpress.service.fees.v1.BulkDeleteRulesResponse"},"legacyExamples":[{"name":"BulkDeleteRules","type":"METHOD","content":{"title":"Bulk delete a rule","request":"curl -X DELETE https://www.wixapis.com/service-fees-rules/v1/rules/delete \\\n-H 'Content-Type: application/json;charset=UTF-8' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"rule_ids\": [\n \"8f6dc28a-a915-446b-ae75-d201f9f462a9\"\n ]'\n}'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"8f6dc28a-a915-446b-ae75-d201f9f462a9\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"rule\": null\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"},"httpMethod":"delete","path":"/v1/bulk/rules/delete","rpcOnly":false,"triggeredEvents":[{"title":"Rule Deleted","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_deleted","sourceRepo":"git@github.com:wix-private/restaurants-bazel.git"}],"serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","errors":[],"exposure":"PUBLIC","permissions":["WIX_RESTAURANTS.SERVICE_FEES_RULES_DELETE"],"externalPermissionScopes":[],"protoArtifactId":"com.wixpress.service.fees:service-fees-rules","serviceArtifactId":"com.wixpress.service.fees.service-fees-rules","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.service.fees.v1.BulkDeleteRulesRequest","responseMessage":"com.wixpress.service.fees.v1.BulkDeleteRulesResponse"},"legacyExamples":[{"name":"BulkDeleteRules","type":"METHOD","content":{"title":"Bulk delete a rule","request":"curl -X DELETE https://www.wixapis.com/service-fees-rules/v1/rules/delete \\\n-H 'Content-Type: application/json;charset=UTF-8' \\\n-H 'Authorization: ' \\\n--data-raw '{\n \"rule_ids\": [\n \"8f6dc28a-a915-446b-ae75-d201f9f462a9\"\n ]'\n}'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"8f6dc28a-a915-446b-ae75-d201f9f462a9\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"rule\": null\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","contentLink":{"displayName":"Bulk Delete Rules","slugifiedName":"bulk-delete-rules"},"permissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"webhooks":[{"summary":"Rule Created","title":"Rule Created","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_created","legacyExamples":[{"name":"RuleCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\":\"123a9562-0ef1-433e-864d-9e62454d4971\",\n \"entityFqdn\":\"wix.service.fees.v1.rule\",\n \"slug\":\"created\",\n \"entityId\":\"3799059d-260f-4f7f-b515-4fe3988a5540\",\n \"createdEvent\":{\n \"entity\":\"{\\\"id\\\":\\\"3799059d-260f-4f7f-b515-4fe3988a5540\\\",\\\"name\\\":\\\"Rule Name\\\",\\\"createdDate\\\":\\\"2024-01-28T14:16:28.525Z\\\",\\\"updatedDate\\\":\\\"2024-01-28T14:16:28.525Z\\\",\\\"amount\\\":{\\\"value\\\":\\\"10\\\",\\\"currency\\\":\\\"EUR\\\"},\\\"fixedFee\\\":{\\\"value\\\":\\\"10\\\",\\\"currency\\\":\\\"EUR\\\"},\\\"condition\\\":{\\\"path\\\":\\\"shippingInfo.logistics.type\\\",\\\"orderFieldPath\\\":\\\"shippingInfo.logistics.type\\\",\\\"expectedType\\\":{\\\"value\\\":\\\"STRING\\\"},\\\"expectedFieldType\\\":\\\"STRING\\\",\\\"list\\\":{\\\"values\\\":[\\\"DELIVERY\\\"]}},\\\"conditionsType\\\":\\\"CONDITION\\\",\\\"conditionType\\\":\\\"CONDITION\\\",\\\"conditionOptions\\\":{\\\"path\\\":\\\"shippingInfo.logistics.type\\\",\\\"orderFieldPath\\\":\\\"shippingInfo.logistics.type\\\",\\\"expectedType\\\":{\\\"value\\\":\\\"STRING\\\"},\\\"expectedFieldType\\\":\\\"STRING\\\",\\\"list\\\":{\\\"values\\\":[\\\"DELIVERY\\\"]}},\\\"enabled\\\":true,\\\"revision\\\":\\\"1\\\",\\\"appId\\\":\\\"9a5d83fd-8570-482e-81ab-cfa88942ee60\\\",\\\"roundingStrategy\\\":\\\"UNKNOWN_ROUNDING_STRATEGY\\\"}\",\n },\n \"eventTime\":\"2024-01-28T14:16:28.535118309Z\",\n \"triggeredByAnonymizeRequest\":false,\n \"entityEventSequence\":\"1\"\n}\n"}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","contentLink":{"displayName":"Rule Created","slugifiedName":"rule-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Rule Updated","title":"Rule Updated","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_updated","legacyExamples":[{"name":"RuleUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\":\"88ff68de-2ad5-47c8-8872-c2479408bc5d\",\n \"entityFqdn\":\"wix.service.fees.v1.rule\",\n \"slug\":\"updated\",\n \"entityId\":\"3799059d-260f-4f7f-b515-4fe3988a5540\",\n \"updatedEvent\":{\n \"currentEntity\":\"{\\\"id\\\":\\\"3799059d-260f-4f7f-b515-4fe3988a5540\\\",\\\"name\\\":\\\"Rule Name 2\\\",\\\"createdDate\\\":\\\"2024-01-28T14:16:28.525Z\\\",\\\"updatedDate\\\":\\\"2024-01-28T14:25:47.220Z\\\",\\\"amount\\\":{\\\"value\\\":\\\"10\\\",\\\"currency\\\":\\\"EUR\\\"},\\\"fixedFee\\\":{\\\"value\\\":\\\"10\\\",\\\"currency\\\":\\\"EUR\\\"},\\\"condition\\\":{\\\"path\\\":\\\"shippingInfo.logistics.type\\\",\\\"orderFieldPath\\\":\\\"shippingInfo.logistics.type\\\",\\\"expectedType\\\":{\\\"value\\\":\\\"STRING\\\"},\\\"expectedFieldType\\\":\\\"STRING\\\",\\\"list\\\":{\\\"values\\\":[\\\"DELIVERY\\\"]}},\\\"conditionsType\\\":\\\"CONDITION\\\",\\\"conditionType\\\":\\\"CONDITION\\\",\\\"conditionOptions\\\":{\\\"path\\\":\\\"shippingInfo.logistics.type\\\",\\\"orderFieldPath\\\":\\\"shippingInfo.logistics.type\\\",\\\"expectedType\\\":{\\\"value\\\":\\\"STRING\\\"},\\\"expectedFieldType\\\":\\\"STRING\\\",\\\"list\\\":{\\\"values\\\":[\\\"DELIVERY\\\"]}},\\\"enabled\\\":true,\\\"revision\\\":\\\"2\\\",\\\"appId\\\":\\\"9a5d83fd-8570-482e-81ab-cfa88942ee60\\\",\\\"roundingStrategy\\\":\\\"UNKNOWN_ROUNDING_STRATEGY\\\"}\"\n },\n \"eventTime\":\"2024-01-28T14:25:47.328707384Z\",\n \"triggeredByAnonymizeRequest\":false,\n \"entityEventSequence\":\"2\"\n}\n"}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","contentLink":{"displayName":"Rule Updated","slugifiedName":"rule-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Rule Deleted","title":"Rule Deleted","description":"","permissions":[],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.service.fees.v1.rule","serviceName":"com.wixpress.service.fees.v1.ServiceFeesRules","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.service.fees.v1.rule_deleted","legacyExamples":[{"name":"RuleDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\":\"784867e9-9168-4781-b804-db19450837e8\",\n \"entityFqdn\":\"wix.service.fees.v1.rule\",\n \"slug\":\"deleted\",\n \"entityId\":\"3799059d-260f-4f7f-b515-4fe3988a5540\",\n \"deletedEvent\":{\n \"movedToTrash\":true\n },\n \"eventTime\":\"2024-01-28T14:27:42.514939826Z\",\n \"triggeredByAnonymizeRequest\":false,\n \"entityEventSequence\":\"3\"\n}\n"}],"sourceRepo":"git@github.com:wix-private/restaurants-bazel.git","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","contentLink":{"displayName":"Rule Deleted","slugifiedName":"rule-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]}],"articles":[{"displayName":"Constructing a Rule","slugifyName":"constructing-a-rule","content":"# Constructing a Rule\n\nA rule has two main parts: conditions and a fee. When [Calculate Service Fees](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fc9af0f0-4ce4-4684-840f-eb512678223fslug::calculate-service-fees*fallback::https://dev.wix.com/docs/rest/internal-only/restaurants/service-fees/rule-v1/calculate-service-fees) is called, it assesses each rule in relation to the specified order. When a rule is assessed, if the conditions are met, the fee is included in the API's response.\n\n## Conditions\n\nConditions can be either a single condition or a condition tree.\n\nA single condition evaluates a specific field in the order. For example, it could check if the value of the field is greater than a certain number.\n\nA condition tree contains two conditions and an operator. The conditions can each be either a single condition or a condition tree. There are two operator values:\n- `\"AND\"`: Both conditions must be met for the condition tree to be considered met.\n- `\"OR\"`: At least one of the conditions must be met for the condition tree to be considered met.\n\n### Condition tree example\n#### Conditions\nFor the service fee to be applied, we would need to satisfy these conditions:\n* The price subtotal is greater than `50`
\n AND\n* Either:\n - Delivery type is `\"DELIVERY\"`
\n OR\n - Order is made in the mobile app\n\n#### Example: Conditions are met\nWe have the following values:\n- Subtotal is `70`\n- Delivery type is `\"DELIVERY\"`\n- Order is `\"WEBSITE\"`\n\nIn this case, the conditions are met, because the subtotal is greater than `50` and the delivery type is `\"DELIVERY\"`. It doesn't matter that the platform isn't `\"MOBILE_APP\"` because we only need that OR delivery type to be `\"DELIVERY\"`.\n\n#### Example: Conditions are not met\nWe have the following values:\n- Subtotal is `30`\n- Delivery type is `\"DELIVERY\"`\n- Order is `\"MOBILE_APP\"`\n\nIn this case, the conditions are not met, because even though the delivery type is `\"DELIVERY\"` and the platform is `\"MOBILE_APP\"`, the subtotal is not greater than `50`. \n\n## Fee\n\nA fee is either a fixed amount or a percentage of the order's subtotal. It can also include tax.\n\nIf the conditions are met, the fee is calculated and applied when Calculate Service Fees is called.\n"},{"displayName":"Supported Filters and Sorting","slugifyName":"supported-filters-and-sorting","content":"# Service Fees: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting\nfor the rules object:\n\n| Field | Supported Filters | Sortable |\n| --------------- | ---------------------------------------------------------------------------------------------------- | -------- |\n| `id` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` | Sortable |\n\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Rules](fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/rules/query-rules)"}],"components":{"schemas":{"com.wixpress.service.fees.v1.Rule":{"type":"object","properties":{"id":{"description":"Rule ID.","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"locationId":{"description":"ID of the restaurant’s [location](https://dev.wix.com/docs/rest/api-reference/business-tools/locations/introduction).","format":"GUID","title":"locationId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"description":"Rule name.","maxLength":50,"minLength":1,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"description":"Date and time the rule was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"updatedDate":{"description":"Date and time the rule was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"taxRate":{"description":"Percentage value to apply as a custom tax rate. For example, `5` respresents a 5% fee applied to the order's total.\n\n\nMin: '0'.\n\nMax: `100`.","title":"taxRate","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"replacedBy":"taxes","targetRemovalDate":"2023-09-16"},"decimalValue":{"maxScale":2,"gte":"0","lte":"100"}}},"conditionsType":{"description":"Specifies the type of condition.","title":"conditionsType","type":"string","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule.ConditionsType","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Specifies the type of condition.","replacedBy":"condition_type","targetRemovalDate":"2024-02-15"}}},"conditionType":{"description":"Specifies the type of condition.","title":"conditionType","type":"string","$ref":"#/components/schemas/com.wixpress.service.fees.v1.ConditionType","x-wix-docs":{"exposure":"PUBLIC"}},"enabled":{"description":"Whether the rule is enabled. If `true`, the rule is evaluated when service fees are calculated. If `false`, the rule will not be evaluated when service fees are calculated.","title":"enabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"revision":{"description":"Revision number. Increments by 1 each time the rule is updated.\nTo prevent conflicting changes, the existing `revision` must be used when updating a rule.","readOnly":true,"title":"revision","type":"integer","format":"uint64","x-wix-docs":{"exposure":"PUBLIC"}},"label":{"description":"DEPRECATED. Defines the app that the rule is connected to.","maxLength":100,"minLength":1,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"DEPRECATED. Defines the app that the rule is connected to.","replacedBy":"app_id","targetRemovalDate":"2023-02-19"}}},"appId":{"description":"Defines the app that the rule is connected to.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"roundingStrategy":{"description":"Rounding strategy to apply to fee and tax calculation.\n\n- `HALF_UP` rounds up any number exactly halfway between two integers. For example, `2.5` rounds to `3`, and `3.5` and rounds to `4`.\n- `HALF_EVEN` rounds such numbers to the nearest even integer. For example, `2.5` rounds to `2`, but `3.5` rounds to `4`.","title":"roundingStrategy","type":"string","$ref":"#/components/schemas/com.wixpress.service.fees.v1.RoundingStrategy","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Rule","description":"","oneOf":[{"description":"","summary":"value","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule.value"},{"description":"","summary":"requirements","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule.requirements"},{"description":"","summary":"conditions","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule.conditions"},{"description":"","summary":"conditionTypeOptions","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule.conditionTypeOptions"},{"description":"","summary":"taxes","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule.taxes"}]},"com.wixpress.service.fees.v1.Rule.value":{"type":"object","title":"value","properties":{"amount":{"description":"Fixed fee. Must hold a positive value.","$ref":"#/components/schemas/wix.common.Money","summary":"amount","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Fixed fee. Must hold a positive value.","replacedBy":"fixed_fee","targetRemovalDate":"2024-02-15"}}},"percentage":{"description":"Percentage fee. For example, `5` respresents a 5% fee applied to the order's total.","title":"percentage","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"replacedBy":"percentage_fee","targetRemovalDate":"2024-02-15"},"decimalValue":{"maxScale":2,"gte":"0","lte":"100"}}}}},"com.wixpress.service.fees.v1.Rule.requirements":{"type":"object","title":"requirements","properties":{"fixedFee":{"description":"Fixed fee. Must hold a positive value.","$ref":"#/components/schemas/wix.common.Money","summary":"fixedFee","x-wix-docs":{"exposure":"PUBLIC"}},"percentageFee":{"description":"Percentage fee. For example, `5` respresents a 5% fee applied to the order's total.","title":"percentageFee","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":2,"gte":"0","lte":"100"}}}}},"com.wixpress.service.fees.v1.Rule.conditions":{"type":"object","title":"conditions","properties":{"condition":{"description":"Single condition that must be met for the rule to be applied to an order.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Condition","summary":"condition","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Single condition that must be met for the rule to be applied to an order.","replacedBy":"condition_options","targetRemovalDate":"2024-02-15"}}},"conditionTree":{"description":"Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.ConditionTree","summary":"conditionTree","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.","replacedBy":"condition_tree_options","targetRemovalDate":"2024-02-15"}}}}},"com.wixpress.service.fees.v1.Rule.conditionTypeOptions":{"type":"object","title":"conditionTypeOptions","properties":{"conditionOptions":{"description":"Single condition that must be met for the rule to be applied to an order.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Condition","summary":"conditionOptions","x-wix-docs":{"exposure":"PUBLIC"}},"conditionTreeOptions":{"description":"Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.ConditionTree","summary":"conditionTreeOptions","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wixpress.service.fees.v1.Rule.taxes":{"type":"object","title":"taxes","properties":{"customTaxRate":{"description":"Percentage value to apply as a custom tax rate. Range: [0-100].","title":"customTaxRate","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"taxGroupId":{"description":"Tax group ID. Internal only.","format":"GUID","title":"taxGroupId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"wix.common.Money":{"type":"object","properties":{"value":{"description":"Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.","format":"DECIMAL_VALUE","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"description":"Currency code. Must be valid ISO 4217 currency code (e.g., USD).","format":"CURRENCY","title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"formattedValue":{"description":"Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.","title":"formattedValue","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Money","description":"Money.\nDefault format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003."},"com.wixpress.service.fees.v1.Condition":{"type":"object","properties":{"path":{"description":"Path of the field in the order entity that this condition will evaluate. For example, `priceSummary.subtotal`.","maxLength":1000,"title":"path","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"replacedBy":"order_field_path","targetRemovalDate":"2024-02-15"}}},"orderFieldPath":{"description":"Path of the field in the order entity that this condition will evaluate. For example, `priceSummary.subtotal`.","maxLength":1000,"title":"orderFieldPath","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"expectedType":{"description":"Type of the field specified in `orderFieldPath`. For example, the type of `priceSummary.subtotal` is `\"NUMBER\"`).","$ref":"#/components/schemas/com.wixpress.service.fees.v1.ExpectedType","summary":"expectedType","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Type of the field specified in `orderFieldPath`. For example, the type of `priceSummary.subtotal` is `\"NUMBER\"`).","replacedBy":"expected_field_type","targetRemovalDate":"2024-02-15"}}},"expectedFieldType":{"description":"Type of the field specified in `orderFieldPath`. For example, the type of `priceSummary.subtotal` is `\"NUMBER\"`).","title":"expectedFieldType","type":"string","$ref":"#/components/schemas/com.wixpress.service.fees.v1.ExpectedFieldType","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Condition","description":"","oneOf":[{"description":"","summary":"value","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Condition.value"}]},"com.wixpress.service.fees.v1.Condition.value":{"type":"object","title":"value","properties":{"number":{"description":"Contains a numeric value and an operation.\n\nRequired if `expectedFiledType` is `NUMBER`.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Number","summary":"number","x-wix-docs":{"exposure":"PUBLIC"}},"list":{"description":"Contains an array of strings to compare with the value of the specified field. If the value of the field matches a string in the array, the condition is considered met.\n\nRequired if `expectedFiledType` is `LIST`.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.List","summary":"list","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wixpress.service.fees.v1.ExpectedType":{"type":"object","properties":{"value":{"description":"Type of the field specified in `orderFieldPath`.","title":"value","type":"string","$ref":"#/components/schemas/com.wixpress.service.fees.v1.ExpectedType.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ExpectedType","description":""},"com.wixpress.service.fees.v1.ExpectedType.Value":{"type":"string","description":"","title":"Value","enum":["NUMBER","LIST","STRING"]},"com.wixpress.service.fees.v1.ExpectedFieldType":{"type":"string","description":"","title":"ExpectedFieldType","enum":["UNKNOWN_EXPECTED_FIELD_TYPE","NUMBER","LIST","STRING"]},"com.wixpress.service.fees.v1.Number":{"type":"object","properties":{"value":{"description":"Numeric value to compare with the value of the specified field.","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"operation":{"description":"Operation to use.\n\n- `EQ`: Equal to.\n- `LT`: Stricly less than.\n- `LE`: Less than or equal to.\n- `GT`: Strictly greater than.\n- `GE`: Greater than or equal to.","title":"operation","type":"string","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Number.Operation","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Number","description":""},"com.wixpress.service.fees.v1.Number.Operation":{"type":"string","description":"","title":"Operation","enum":["EQ","LT","LE","GT","GE"]},"com.wixpress.service.fees.v1.List":{"type":"object","properties":{"values":{"description":"Array of string values to compare with the value of the field. If the value of the fields matches a string in the array, the condition is considered met.","minItems":1,"maxItems":100,"minLength":1,"maxLength":100,"title":"values","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"List","description":""},"com.wixpress.service.fees.v1.ConditionTree":{"type":"object","properties":{"operator":{"description":"Specifies the logical operator to use when combining the evaluation of the left and right conditions.","title":"operator","type":"string","$ref":"#/components/schemas/com.wixpress.service.fees.v1.ConditionTree.Operator","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ConditionTree","description":"Used to represent a logical condition in the form of a tree structure.","oneOf":[{"description":"","summary":"leftConditionNode","$ref":"#/components/schemas/com.wixpress.service.fees.v1.ConditionTree.leftConditionNode"},{"description":"","summary":"rightConditionNode","$ref":"#/components/schemas/com.wixpress.service.fees.v1.ConditionTree.rightConditionNode"}]},"com.wixpress.service.fees.v1.ConditionTree.leftConditionNode":{"type":"object","title":"leftConditionNode","properties":{"leftCondition":{"description":"Single condition that must be met for the rule to be applied to an order.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Condition","summary":"leftCondition","x-wix-docs":{"exposure":"PUBLIC"}},"leftConditionsTree":{"description":"Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.ConditionTree","summary":"leftConditionsTree","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wixpress.service.fees.v1.ConditionTree.rightConditionNode":{"type":"object","title":"rightConditionNode","properties":{"rightCondition":{"description":"Single condition that must be met for the rule to be applied to an order.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Condition","summary":"rightCondition","x-wix-docs":{"exposure":"PUBLIC"}},"rightConditionsTree":{"description":"Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.ConditionTree","summary":"rightConditionsTree","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wixpress.service.fees.v1.ConditionTree.Operator":{"type":"string","description":"","title":"Operator","enum":["AND","OR"]},"com.wixpress.service.fees.v1.Rule.ConditionsType":{"type":"string","description":"","title":"ConditionsType","enum":["NO_CONDITIONS","CONDITION","CONDITION_TREE"]},"com.wixpress.service.fees.v1.ConditionType":{"type":"string","description":"","title":"ConditionType","enum":["UNDEFINED_CONDITION_TYPE","CONDITION","CONDITION_TREE"]},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"google.protobuf.UInt64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UInt64Value","description":""},"com.wixpress.service.fees.v1.RoundingStrategy":{"type":"string","description":"","title":"RoundingStrategy","enum":["UNKNOWN_ROUNDING_STRATEGY","HALF_UP","HALF_EVEN"]},"com.wixpress.service.fees.v1.CalculateServiceFeesRequest":{"type":"object","properties":{"order":{"description":"Order information needed to evaluate the rules and calculate the relevant fees.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Order","summary":"order","x-wix-docs":{"exposure":"PUBLIC"}},"label":{"description":"DEPRECATED. Defines the app that the rule is connected to.","maxLength":100,"minLength":1,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"DEPRECATED. Defines the app that the rule is connected to.","replacedBy":"app_id","targetRemovalDate":"2023-02-19"}}},"appId":{"description":"Defines the app that the rule is connected to.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CalculateServiceFeesRequest","description":""},"com.wixpress.service.fees.v1.Order":{"type":"object","properties":{"id":{"description":"Order ID.","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"locationId":{"description":"ID of the site's location.","format":"GUID","title":"locationId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"description":"Currency used for pricing on the site.","format":"CURRENCY","title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"priceSummary":{"description":"Information about the price of the order.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.PriceSummary","summary":"priceSummary","x-wix-docs":{"exposure":"PUBLIC"}},"shippingInfo":{"description":"Order's shipping information.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.ShippingInformation","summary":"shippingInfo","x-wix-docs":{"exposure":"PUBLIC"}},"platform":{"description":"Platform on which the order was placed.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Platform","summary":"platform","x-wix-docs":{"exposure":"PUBLIC"}},"locale":{"description":"Order's locale.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Locale","summary":"locale","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Order","description":""},"com.wixpress.service.fees.v1.PriceSummary":{"type":"object","properties":{"subtotal":{"description":"Subtotal of the order.","title":"subtotal","type":"string","x-wix-docs":{"exposure":"PUBLIC","decimalValue":{"maxScale":3}}}},"title":"PriceSummary","description":""},"com.wixpress.service.fees.v1.ShippingInformation":{"type":"object","properties":{"logistics":{"description":"Information about the type of delivery. For example, pick-up.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.DeliveryLogistics","summary":"logistics","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ShippingInformation","description":""},"com.wixpress.service.fees.v1.DeliveryLogistics":{"type":"object","properties":{"type":{"description":"Type of delivery. For example, pick-up.","title":"type","type":"string","$ref":"#/components/schemas/com.wixpress.service.fees.v1.DeliveryLogistics.Type","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeliveryLogistics","description":""},"com.wixpress.service.fees.v1.DeliveryLogistics.Type":{"type":"string","description":"","title":"Type","enum":["UNSPECIFIED_FULFILLMENT_TYPE","PICKUP","DELIVERY","DINE_IN","CURBSIDE_PICKUP"]},"com.wixpress.service.fees.v1.Platform":{"type":"object","properties":{"value":{"description":"Patform on which the order was placed.","title":"value","type":"string","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Platform.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Platform","description":""},"com.wixpress.service.fees.v1.Platform.Value":{"type":"string","description":"","title":"Value","enum":["SITE","MOBILE_SITE","MOBILE_APP"]},"com.wixpress.service.fees.v1.Locale":{"type":"object","properties":{"languageCode":{"description":"Locale in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nTypically, this is a lowercase 2-letter language code,\nfollowed by a hyphen, followed by an uppercase 2-letter country code.\nFor example, `en-US` for U.S. English, and `de-DE` for Germany German.","title":"languageCode","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"country":{"description":"2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.","title":"country","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Locale","description":""},"com.wixpress.service.fees.v1.CalculateServiceFeesResponse":{"type":"object","properties":{"calculatedFees":{"description":"A list of calculated fees based on rules evaluation.","title":"calculatedFees","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.CalculatedFee"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CalculateServiceFeesResponse","description":""},"com.wixpress.service.fees.v1.CalculatedFee":{"type":"object","properties":{"ruleId":{"description":"The ID of the rule that was used to calculate the fee.","format":"GUID","title":"ruleId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"description":"The name of the rule that was used to calculate the fee.","readOnly":true,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fee":{"description":"Fee amount.","$ref":"#/components/schemas/wix.common.Money","summary":"fee","x-wix-docs":{"exposure":"PUBLIC"}},"tax":{"description":"Tax amount.","$ref":"#/components/schemas/wix.common.Money","summary":"tax","x-wix-docs":{"exposure":"PUBLIC"}},"taxGroupId":{"description":"Tax group ID. This is an alternative to calculating the tax amount manually.","format":"GUID","title":"taxGroupId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CalculatedFee","description":""},"com.wixpress.service.fees.v1.CreateRuleRequest":{"type":"object","properties":{"rule":{"description":"Rule to create.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","summary":"rule","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateRuleRequest","description":""},"com.wixpress.service.fees.v1.CreateRuleResponse":{"type":"object","properties":{"rule":{"description":"Created rule","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","summary":"rule","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateRuleResponse","description":""},"com.wixpress.service.fees.v1.GetRuleRequest":{"type":"object","properties":{"ruleId":{"description":"ID of the rule to retrieve.","format":"GUID","title":"ruleId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetRuleRequest","description":""},"com.wixpress.service.fees.v1.GetRuleResponse":{"type":"object","properties":{"rule":{"description":"The retrieved rule.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","summary":"rule","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetRuleResponse","description":""},"com.wixpress.service.fees.v1.UpdateRuleRequest":{"type":"object","properties":{"rule":{"description":"Rule to update.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","summary":"rule","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateRuleRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FieldMask","description":""},"com.wixpress.service.fees.v1.UpdateRuleResponse":{"type":"object","properties":{"rule":{"description":"Updated rule.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","summary":"rule","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateRuleResponse","description":""},"com.wixpress.service.fees.v1.DeleteRuleRequest":{"type":"object","properties":{"ruleId":{"description":"ID of the rule to delete.","format":"GUID","title":"ruleId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeleteRuleRequest","description":""},"com.wixpress.service.fees.v1.DeleteRuleResponse":{"type":"object","properties":{},"title":"DeleteRuleResponse","description":""},"com.wixpress.service.fees.v1.ListRulesRequest":{"type":"object","properties":{"locationId":{"description":"Retrieve only rule that apply at the [location](https://dev.wix.com/docs/rest/api-reference/business-tools/locations/location-object) with this ID. If this field is `null`, the rules will not be filtered by location.","format":"GUID","title":"locationId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"label":{"description":"DEPRECATED. Defines the app that the rule is connected to.","maxLength":100,"minLength":1,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"DEPRECATED. Defines the app that the rule is connected to.","replacedBy":"app_id","targetRemovalDate":"2023-02-19"}}},"appId":{"description":"Defines the app that the rule is connected to.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListRulesRequest","description":""},"com.wixpress.service.fees.v1.ListRulesResponse":{"type":"object","properties":{"rules":{"description":"Array containing the retrieved rules.","title":"rules","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListRulesResponse","description":""},"com.wixpress.service.fees.v1.QueryRulesRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.upstream.wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryRulesRequest","description":""},"com.wixpress.service.fees.v1.upstream.wix.common.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object.\nSee [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\nfor more information.\n\nFor a detailed list of supported filters, see\n[Supported Filters](/supported-filters-and-sorting).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"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"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.service.fees.v1.upstream.wix.common.CursorQuery.pagingMethod"}]},"com.wixpress.service.fees.v1.upstream.wix.common.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC"}}}},"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"}}},"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"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"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"}}},"title":"ListValue","description":""},"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"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wixpress.service.fees.v1.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Number of items to load.\n\nDefault: `50`","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CursorPaging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int32Value","description":""},"com.wixpress.service.fees.v1.QueryRulesResponse":{"type":"object","properties":{"rules":{"description":"The retrieved rules.","title":"rules","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule"},"x-wix-docs":{"exposure":"PUBLIC"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryRulesResponse","description":""},"com.wixpress.service.fees.v1.upstream.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"}},"cursors":{"description":"Offset that was requested.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC"}},"hasNext":{"description":"Indicates if there are more results after the current page.\nIf `true`, another page of results can be retrieved.\nIf `false`, this is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CursorPagingMetadata","description":""},"com.wixpress.service.fees.v1.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor pointing to next page in the list of results.","title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"prev":{"description":"Cursor pointing to previous page in the list of results.","title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Cursors","description":""},"com.wixpress.service.fees.v1.BulkCreateRulesRequest":{"type":"object","properties":{"rules":{"description":"Rules to create.","title":"rules","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule"},"x-wix-docs":{"exposure":"PUBLIC"}},"returnFullEntity":{"description":"Whether the full rule entity is returned.\n\nDefault: `false`.","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkCreateRulesRequest","description":""},"com.wixpress.service.fees.v1.BulkCreateRulesResponse":{"type":"object","properties":{"results":{"description":"The created rules. Omitted if `returnFullEntity` is set to false.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.BulkRuleResult"},"x-wix-docs":{"exposure":"PUBLIC"}},"bulkActionMetadata":{"description":"Bulk Create Rule metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkCreateRulesResponse","description":""},"com.wixpress.service.fees.v1.BulkRuleResult":{"type":"object","properties":{"itemMetadata":{"description":"Metadata of the rule.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC"}},"rule":{"description":"The created rule.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","summary":"rule","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkRuleResult","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"}},"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"}},"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"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC"}}},"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"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkActionMetadata","description":""},"com.wixpress.service.fees.v1.BulkUpdateRulesRequest":{"type":"object","properties":{"rules":{"description":"Masked rules to update.","title":"rules","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.MaskedRule"},"x-wix-docs":{"exposure":"PUBLIC"}},"returnFullEntity":{"description":"Whether the full rule entity is returned.\n\nDefault: `false`.","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkUpdateRulesRequest","description":""},"com.wixpress.service.fees.v1.MaskedRule":{"type":"object","properties":{"rule":{"description":"Rule to update.","$ref":"#/components/schemas/com.wixpress.service.fees.v1.Rule","summary":"rule","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MaskedRule","description":""},"com.wixpress.service.fees.v1.BulkUpdateRulesResponse":{"type":"object","properties":{"results":{"description":"The updated rules. Omitted if `returnFullEntity` is set to false.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.BulkRuleResult"},"x-wix-docs":{"exposure":"PUBLIC"}},"bulkActionMetadata":{"description":"Bulk Update Rule metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkUpdateRulesResponse","description":""},"com.wixpress.service.fees.v1.BulkDeleteRulesRequest":{"type":"object","properties":{"ruleIds":{"description":"IDs of the rules to delete.","format":"GUID","title":"ruleIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkDeleteRulesRequest","description":""},"com.wixpress.service.fees.v1.BulkDeleteRulesResponse":{"type":"object","properties":{"results":{"description":"Information about the deleted rules.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.service.fees.v1.BulkRuleResult"},"x-wix-docs":{"exposure":"PUBLIC"}},"bulkActionMetadata":{"description":"Bulk Delete Rule metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkDeleteRulesResponse","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"}},"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"}},"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"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"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"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"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"}}},"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"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"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"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int64Value","description":""}}},"title":"Rule","description":"A rule defines the fee that is applied when specific conditions (also defined by the rule) are met. You can use a rule to apply a service fee to a restaurant order.","fqdn":"wix.service.fees.v1.rule"},"articles":[{"displayName":"Constructing a Rule","slugifyName":"constructing-a-rule","content":"# Constructing a Rule\n\nA rule has two main parts: conditions and a fee. When [Calculate Service Fees](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::fc9af0f0-4ce4-4684-840f-eb512678223fslug::calculate-service-fees*fallback::https://dev.wix.com/docs/rest/internal-only/restaurants/service-fees/rule-v1/calculate-service-fees) is called, it assesses each rule in relation to the specified order. When a rule is assessed, if the conditions are met, the fee is included in the API's response.\n\n## Conditions\n\nConditions can be either a single condition or a condition tree.\n\nA single condition evaluates a specific field in the order. For example, it could check if the value of the field is greater than a certain number.\n\nA condition tree contains two conditions and an operator. The conditions can each be either a single condition or a condition tree. There are two operator values:\n- `\"AND\"`: Both conditions must be met for the condition tree to be considered met.\n- `\"OR\"`: At least one of the conditions must be met for the condition tree to be considered met.\n\n### Condition tree example\n#### Conditions\nFor the service fee to be applied, we would need to satisfy these conditions:\n* The price subtotal is greater than `50`
\n AND\n* Either:\n - Delivery type is `\"DELIVERY\"`
\n OR\n - Order is made in the mobile app\n\n#### Example: Conditions are met\nWe have the following values:\n- Subtotal is `70`\n- Delivery type is `\"DELIVERY\"`\n- Order is `\"WEBSITE\"`\n\nIn this case, the conditions are met, because the subtotal is greater than `50` and the delivery type is `\"DELIVERY\"`. It doesn't matter that the platform isn't `\"MOBILE_APP\"` because we only need that OR delivery type to be `\"DELIVERY\"`.\n\n#### Example: Conditions are not met\nWe have the following values:\n- Subtotal is `30`\n- Delivery type is `\"DELIVERY\"`\n- Order is `\"MOBILE_APP\"`\n\nIn this case, the conditions are not met, because even though the delivery type is `\"DELIVERY\"` and the platform is `\"MOBILE_APP\"`, the subtotal is not greater than `50`. \n\n## Fee\n\nA fee is either a fixed amount or a percentage of the order's subtotal. It can also include tax.\n\nIf the conditions are met, the fee is calculated and applied when Calculate Service Fees is called.\n"},{"displayName":"Supported Filters and Sorting","slugifyName":"supported-filters-and-sorting","content":"# Service Fees: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting\nfor the rules object:\n\n| Field | Supported Filters | Sortable |\n| --------------- | ---------------------------------------------------------------------------------------------------- | -------- |\n| `id` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` | Sortable |\n\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Rules](fallback::https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/rules/query-rules)"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}