GET

List Rules

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 an array of all rules.

You can filter by location or app that the rules are associated with.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/service-fees/v1/rules
Query Params
locationIdstring

Retrieve only rule that apply at the location with this ID. If this field is null, the rules will not be filtered by location.

labelstringdeprecated - use appId instead

DEPRECATED. Defines the app that the rule is connected to.

appIdstring

Defines the app that the rule is connected to.

Response Object
rulesArray <Rule>

Array containing the retrieved rules.

List rules associated with a specific location and specific app
Request
cURL
curl -X GET https://www.wixapis.com/service-fees-rules/v1/rules \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
--data-raw '{
    "locationId": "d84423ab-f73d-44a9-9ffb-f36fb163dc6b",
    "appId": "d84429ab-f73d-44a9-9ffb-f36fb163dc6b"
}'
Response
JSON
{
  "rules": [
    {
      "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"
      },
      "locationId": "d84423ab-f73d-44a9-9ffb-f36fb163dc6b"
    },
    {
      "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": "12.9",
      "conditionType": "CONDITION",
      "enabled": false,
      "roundingStrategy": "HALF_EVEN",
      "customTaxRate": "11",
      "conditionOptions": {
        "orderFieldPath": "priceSummary.subtotal",
        "expectedFieldType": "NUMBER",
        "number": {
          "value": "10",
          "operation": "EQ"
        }
      },
      "percentageFee": "11.9",
      "locationId": "d84423ab-f73d-44a9-9ffb-f36fb163dc6b"
    }
  ]
}
Errors

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

Did this help?