GuidesAPI ReferenceChangelog
HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In
API Reference
Start typing to search…

Updates details of an ServiceFee object

patch
https://api-sandbox-revel.revelup.com/resources/ServiceFee//

Updates details of an ServiceFee object specified by ID

Path Params
int64
required

ID of ServiceFee to update

Body Params

ServiceFee data that needs to be changed

boolean
Defaults to true
string
string
required

Rule amount used for calculation total money amount

integer
enum
required

Type: Item = 0, Order = 1

Service Fee Application Types:

  • 0 - ITEM
  • 1 - ORDER
Allowed:
integer
enum
required

Integer representing ServiceFee to be applied to subtotal of the order, or post tax or pre discount of the order.

ServiceFeeApplyToTypes:

  • 0 - FEE_APPLY_TOSUBTOTAL
  • 1 - FEE_APPLY_TO_POST_TAX
  • 2 - FEE_APPLY_TO_PRE_DISCOUNT
Allowed:
boolean

Flag reflecting the rule of calculation total amount. For percent service fees only. If post tax = true - service fee is calculated from total with tax, otherwise from subtotal (pre tax amount).

autoapply_data
integer
enum

Available options: 0: Timeslot, 1: Payment type, 2: Guest count, 3; Dining type

Service Fee Autoapply Options:

  • 1 - AUTOAPPLY_TIMESLOT
  • 2 - AUTOAPPLY_PAYMENTTYPE
  • 3 - AUTOAPPLY_GUESTCOUNT
  • 4 - AUTOAPPLY_DININGTYPE
Allowed:
uri
required

URI of an User API object which is responsible for this object creation

date-time

Date and time when this object created

boolean
Defaults to false

Flag which shows that we should use data from request, not from setting on backend. Used in Online Ordering

uri
required

Relation to Establishment where this object was created

integer
enum

Integer representing Employee Pass through ServiceFee include options in Payroll, cash due.

EnumIncludeEmployeePassThroughServiceFeeInOptions:

  • 0 - DEFAULT_FEE
  • 1 - PAYROLL_FEE
  • 2 - CASH_DUE_FEE
  • 3 - PAYROLL_AND_CASH_DUE_FEE
Allowed:
string

Maximum distance to apply distance based Service fee. Unit is based on Delivery Unit of Measure.

string

Maximum taxable amount

string

Minimum distance to apply distance based Service fee. Unit is based on Delivery Unit of Measure.

string
required

Minimum taxable amount

string
required

Name of ServiceFee

integer
enum

Integer representing Pass through ServiceFee for Employee or Thirdparty, including choices for all and not a pass through.

EnumServiceFeePassThroughTypeChoices:

  • -1 - ALL_PASS_THROUGH_FEES
  • 0 - NOT_A_PASS_THROUGH
  • 1 - FEE_TYPE_THIRD_PARTY
  • 2 - FEE_TYPE_EMPLOYEE
  • 3 - FEE_TYPE_OTHER
Allowed:
boolean
Defaults to false

Used on POS for checking for permisson on service fee. If the user does not have permission, he will be prompted to enter a password.

boolean
Defaults to false

Flag which shows how we should compare threshold for service fee: from total before or after discount

qualification_product_ids
array of integers

List of ids of products

qualification_product_ids
integer
enum

Used for auto service fee by dining option. Applies only for specific products. 0: none, 1: classes, 2: groups, 3: products

Service Fee Qualification Types:

  • 0 - QUALIFICATION_TYPE_NONE
  • 1 - QUALIFICATION_TYPE_CLASSES
  • 2 - QUALIFICATION_TYPE_GROUPS
  • 3 - QUALIFICATION_TYPE_PRODUCTS
Allowed:
uri

URI of this object

integer
enum
required

Type: Amount = 0, Percent = 1

Service Fee Type Options:

  • 0 - SERVICE_FEE_TYPE_AMOUNT
  • 1 - SERVICE_FEE_TYPE_PERCENT
Allowed:
boolean
Defaults to false

Flag reflecting if service fee should be taxed

uri
required

URI of the user that last updated this object

date-time

Date and time when this object was updated

boolean
Defaults to false

Flag. It is used to calculate distance based service fee for delivery. Available for delivery orders only.

boolean
Defaults to false

If true, ServiceFee is variable

boolean
Defaults to false

Flag. Zone based service fees are generally used for delivery as an alternative to distance based fees. Fees are assessed against the Customer’s address. In the case of overlapping zones, the lowest fee will be assessed. Currently Zone based service fees can only be applied to delivery orders.

zone_geojson
object

Input your GeoJson delivery zone string here. GeoJson Zones may be generated using a tool like geojson.io. Currently only polygon based zones are supported

Responses

400

Bad request. Usually not valid data provided.

404

ServiceFee not found

Updated about 1 month ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago