Introduction

The Service Fees API allows you to manage your service fee rules and apply them to orders.

With the Service Fees API, you can:

• Create and manage rules for service fees.
• Implement custom pricing and fee structures for restaurant orders.
• Adjust service fees automatically based on certain rules or conditions.

Before you begin

It's important to note the following point before starting to code:

• This API requires Wix Restaurants Orders (New) to be installed on the site calling the API. If you are using this API in an app, add Wix Restaurants Orders (New) as an app dependency.

Terminology

• Order: Information about an order that is placed by a customer. It contains necessary information to calculate service fees. The order has not yet been placed, it is in the pre-checkout stage.
• Condition: Evaluates a specific field in the order.
• Condition Tree: Contains two conditions and an operator.
• Rule: Defines the fee that is applied when specific conditions (also defined by the rule) are met.

Setup

To use the ServiceFeesCalculate API, install the @wix/restaurants package using npm or Yarn:

1
npm install @wix/restaurants

or

1
yarn add @wix/restaurants

Then import { serviceFeesCalculate } from @wix/restaurants:

1
import { serviceFeesCalculate } from '@wix/restaurants'

Constructing a Rule

A rule has two main parts: conditions and a fee. When calculateServiceFees() 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

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 calculateServiceFees() is called.