GET

Get Rule

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a rule.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/service-fees/v1/rules/{ruleId}
Path Params
ruleIdstringRequired

ID of the rule to retrieve.

Response Object
ruleRule

The retrieved rule.

Get a rule
Request
cURL
curl -X GET https://www.wixapis.com/service-fees-rules/v1/rules/4aea505e-ac49-4f72-b4f1-b07c064a20cd \
    -H 'Authorization: <AUTH>'
Response
JSON
{
  "rule": {
    "id": "4aea505e-ac49-4f72-b4f1-b07c064a20cd",
    "revision": "1",
    "createdDate": "2023-12-10T07:06:39.306Z",
    "updatedDate": "2023-12-10T07:06:39.306Z",
    "name": "rule_name",
    "taxRate": "21.9",
    "conditionType": "CONDITION",
    "enabled": true,
    "roundingStrategy": "HALF_UP",
    "customTaxRate": "20",
    "conditionOptions": {
      "orderFieldPath": "priceSummary.subtotal",
      "expectedFieldType": "NUMBER",
      "number": {
        "value": "5.9",
        "operation": "GT"
      }
    },
    "fixedFee": {
      "value": "21.3",
      "currency": "USD"
    }
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?