Constructing a Rule
A rule has two main parts: conditions and a fee. When 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.
Conditions
Conditions can be either a single condition or a condition tree.
A 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.
A 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:
"AND"
: Both conditions must be met for the condition tree to be considered met."OR"
: At least one of the conditions must be met for the condition tree to be considered met.
Condition tree example
Conditions
For the service fee to be applied, we would need to satisfy these conditions:
- The price subtotal is greater than
50
AND - Either:
- Delivery type is
"DELIVERY"
OR - Order is made in the mobile app
- Delivery type is
Example: Conditions are met
We have the following values:
- Subtotal is
70
- Delivery type is
"DELIVERY"
- Order is
"WEBSITE"
In 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"
.
Example: Conditions are not met
We have the following values:
- Subtotal is
30
- Delivery type is
"DELIVERY"
- Order is
"MOBILE_APP"
In 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
.
Fee
A fee is either a fixed amount or a percentage of the order's subtotal. It can also include tax.
If the conditions are met, the fee is calculated and applied when Calculate Service Fees is called.
Service Fees: Supported Filters and Sorting
The following table shows field support for filters and sorting for the rules object:
Field | Supported Filters | Sortable |
---|---|---|
id | $eq , $ne , $lt , $lte , $gt , $gte , $in , $hasSome , $hasAll , $startsWith , $contains | Sortable |
Related content: API Query Language, Query Rules
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.
- 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.
- HALF_EVEN rounds such numbers to the nearest even integer. For example, 2.5 rounds to 2, but 3.5 rounds to 4.
ONE OF:
ONE OF:
ONE OF:
ONE OF:
ONE OF:
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Calculates service fees for an order.
The 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.
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.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a rule.
To create multiple rules at once, use Bulk Create Rules.
Read more about constructing a rule.
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.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deletes a rule.
To delete mutiple rules at once, use Bulk Delete Rules.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Updates a rule.
Each 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.
To update multiple rules at once, use Bulk Update Rules.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of rules, given the provided paging, filtering, and sorting.
For field support for filters and sorting, see Service Fees: Supported Filters and Sorting.
Query Rules runs with these defaults, which you can override:
cursorPaging.limit
is50
To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Bulk updates rules.
Each 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.
To update a single rule, use Update Rule.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Bulk deletes rules.
To delete a single rule, use Delete Rule.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.