Add or Update Booking Session Beverage

Add or Update Booking Session Beverage

POST [PlatformAddress]/api/1.0/venue?action=addOrUpdateBookingSessionBeverage

Adds or updates the details of a venue booking session beverages. NOTE: The venue must have access to add or update booking session beverage in order to call this api action.

{
  "success": true,
  "id": 1234
}

Booking Session Beverage

Property
Type
Required
Description

id

integer

optional

The unique id of the booking session beverage package to update. A new booking session beverage will be created if this parameter is not present.

venueId

integer

required

The unique id of the venue to which the booking session beverage package belongs.

bookingId

integer

optional

The unique id of the booking to which the new booking session beverage package will be assigned.

sessionId

integer

optional

The unique id of the booking session to which the new booking session beverage package will be assigned.

beverageId

integer

optional

The unique id of the beverage package which is being added to the booking session

name

string

optional

The booking session beverage package name. Required when adding a new booking session beverage package.

minAttendeesGuaranteed

integer

optional

The total attendees of the booking session beverage package. Required when adding new booking session beverage package.

startTime

string

optional

The start time of the booking session beverage package. Format is HH:mm:ss

endTime

string

optional

The end time of the booking session beverage package. Format is HH:mm:ss

includeInPackage

boolean

optional

Whether or not the booking session beverage package is included in booking package.

bookingPackageId

integer

optional

The unique id of the booking package to which the booking session beverage package belongs. Required when includeInPackage is true.

costcenterId

integer

optional

The unique id of the cost center to which the booking session beverage package belongs. Required when adding new booking session beverage package.

cost

double

optional

The price of the booking session beverage package. Required when includeInPackage is false.

excludedTaxIds

array

optional

The array of tax Ids which are excluded to apply on the booking session beverage package. Required when includeInPackage is false.

costPeriod

integer

optional

The period of the cost of the booking session beverage package. Required when the selected beverage package is hourly. 1 = Hourly, 2 = Daily

numHours

float

optional

The number of hours of the booking session beverage needed. Required when the cost period is hourly. The value must match with one of the hours added in Venue Setup > Beverages > Packages > Hourly Prices. For example, for 3 hours and 45 minutes, pass 3.75.

sortOrder

integer

optional

The sort order of the booking session beverage package.

excludedFromCommissions

boolean

optional

Whether this booking session beverage excluded from commission. Only applicable when booking is commissionable. Default is true.

items

array

optional

Beverage Item

A booking session beverage item is an object with the following details.

Property
Type
Required
Description

itemId

integer

required

The unique id of the beverage item

name

string

optional

The name of the beverage item. Do not pass it to automatically set the name from setup

quantity

integer

optional

The quantity of the beverage item. Do not pass it to automatically set the quantity from setup

price

double

optional

The price of the optional beverage item.

Adding/Updating items

While adding you can skip the items parameter, this will add all the non-optional beverge items to the beverage package automatically. Passing items will only add those items to the beverage package including any required non-removable items.

While updating you can skip the items parameter, this will not change any of the items. Passing items will replace the items with the given items. Required non-removable items cannot be removed from the beverage package.

Last updated