iVvy Developer API
  • API Documentation
  • Getting Started
    • Obtaining Keys
    • Creating the request
      • Method/URI Header
      • Request Headers
        • Standard Headers
        • Custom Headers
      • Signing the request
      • Query Parameters
    • Test Ping
    • Interpreting the response
      • Collections
      • Pagination
      • Filtering
      • Exceptions
      • Response Headers
      • Dates
    • Batch
      • Run
      • Progress
      • Result
      • Restart
      • Repost
    • Use Cases
      • CRM Systems
      • Financial Accounting Systems
      • Point Of Sale
      • Property Management Systems
  • Contacts & Companies
    • Get Contact List
    • Get Contact
    • Get Contact Note List
    • Add or Update Contact
    • Get Contact Custom Field Definition
    • Get Company Custom Field Definition
    • Get Subscription Group List
    • Add Contacts To Subscription Group
    • Remove Contacts From Subscription Group
    • Get Company List
    • Get Company
    • Get Company Note List
    • Add or Update Company
    • Add or Update Lead
    • Add or Update Contact Note
    • Add or Update Company Note
  • Event
    • Add or Update Event
    • Get Event List
    • Get Event
    • Get Registration
    • Get Registration List
    • Get Attendee
    • Get Attendee List
    • Get Invited Contact List
    • Invite Contacts
    • Get Sponsorship List
    • Get Speaker List
    • Get Session List
    • Create Login Token
  • Venue
    • Venue Setup Data
      • Get Venue
      • Get Venue List
      • Get Venue Room List
      • Get Venue Room Option List
      • Get Venue Rate Plan List
      • Get Venue Rate Plan Rate List
      • Get Venue Rate Plan Room Rate List
      • Get Resource List
      • Get Resource Availability
      • Get Menu List
      • Get Beverage Package List
      • Get Function Space List
      • Get Space Blockout List
      • Get Function Space Category List
      • Get Function Space Availability
      • Get Function Space Hire Plan Rate List
      • Get Function Space Hire Plan Rate
      • Get Cost Center List
      • Get Session Type List
      • Get Revenue Template List
      • Get Tax List
      • Add or Update Function Space
      • Get Event Type List
      • Add or Update Function Space Category
      • Add or Update Guest Room
      • Get Booking Custom Field List
      • Get Space Hire Plans
      • Get Venue Package List
      • Get Venue Package
    • Booking Data
      • Convert Lead To Opportunity
      • Add or Update Opportunity
      • Get Booking
      • Get Booking List
      • Get Booking List For Account
      • Get Booking Notes
      • Get Booking Session List
      • Get Booking Session Menu List
      • Get Booking Changelog List
      • Get Booking Attendee (By Hash)
      • Get Booking Attendee List
      • Get Booking Release Schedule
      • Add or Update Booking
      • Change Booking Status
      • Add Items To Booking
      • Add Payment To Booking
      • Add Refund To Booking
      • Add or Update Booking Attendee
      • Add or Update Booking Note
      • Add or Update Booking Session
      • Add or Update Booking Session Beverage
      • Add or Update Booking Session Menu
      • Add or Update Booking Session Resource
      • Remove Booking Session
      • Remove Booking Session Beverage
      • Remove Booking Session Menu
      • Remove Booking Session Resource
      • Get Space Blockout List
      • Add or Update Blockout Space
      • Remove Blockout Space
      • Get Booking Tax List
      • Add or Update Opportunity Note
      • Add or Update Booking Package
      • Get Booking Document List
      • Get Booking BEO List
      • Get Booking BEO Version List
      • Upload Booking Document
    • Booking Accommodation Data
      • Get Booking Accommodation List
      • Add or Update Booking Accommodation
      • Remove Booking Accommodation
      • Get Booking Room Reservation List
      • Add or Update Booking Room Reservation
      • Update Room Reservation Guest Contact
      • Remove Booking Room Reservation
      • Confirm Booking Room Reservation
      • Cancel Booking Room Reservation
      • Change Status of Booking Room Reservation
      • Add or Update Room Counts
      • Add or Update Room Dynamic Rates
      • Remove Room Dynamic Rates
      • Add or Update Rate Plan Booking Rules
  • Partner
    • Get Venue List
    • Get Venue
  • Invoice
    • Get Invoice List
    • Get Invoice
    • Get Options
    • Add Payment
    • Get Credit Note List
    • Get Credit Note
  • Account
    • Add or Update Cost Center
    • Get Cost Center List
    • Get Email Log List
    • Get Industry List
    • Add Error Report
    • Get Account User List
  • CRM
    • Get Lead List
    • Get Opportunity List
    • Get Opportunity Note List
    • Get Task List
    • Get Activity List
    • Get Lead Stage List
    • Get Lead Type List
    • Get Lead Quality List
    • Get Lead Source List
    • Get Lead Channel List
    • Get Lead Note List
    • Add or Update Activity Purpose
    • Add or Update Activity
    • Add or Update Task
    • Add or Update Lead Quality
    • Add or Update Lead Stage
    • Add or Update Lead Channel
    • Add or Update Lead Type
    • Add or Update Lead Source
    • Add or Update Lead Note
  • Notifications
    • Company Endpoint
    • Contact Endpoint
    • CRM Endpoint
    • Invoice Endpoint
    • Booking Endpoint
    • Event Endpoint
  • Development Reference
    • Calculating md5
    • HMAC-SHA1
    • JSON Encoding
    • Timestamp Format
    • Date Format
    • Time Format
    • Address Format
    • URLEncoding
    • Timezone List
  • Announcements
    • Room Reservation Contact Changes
    • Contact Customfield Changes
    • Booking Accommodation API Changes
    • Invoice Endpoints Changes
Powered by GitBook
On this page
  • Add or Update Booking Package
  • Booking Package
  • Example Request
  • Returns
  • Throws
  • Costcenter
  • Response Warnings
  1. Venue
  2. Booking Data

Add or Update Booking Package

Add or Update Booking Package

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

Adds or updates the details of a venue booking package.

{
  "success": true,
  "id": 8821,
  "warnings": null
}

Booking Package

Property
Type
Required
Description

id

integer

optional

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

venueId

integer

required

The id of the venue to which the booking package belongs.

bookingId

integer

required

The id of the booking to which the booking package belongs.

packageId

integer

required

The id of the venue setup package to which the booking package belongs.

bookingDate

date

optional

Start date of the package. Ignored if id is set.

price

double

optional

The price of the booking package.

costcenters

optional

The cost centers of the booking package. If "price" not passed this will use calculate the allocation based on setup venue setup package

mainSpaceVenueId

integer

optional

The id of the space venue associated with a booking package session. If space is not set within the package session, this value should be provided. Ignored if id is set.

mainSpaceId

integer

optional

The id of the space associated with a booking package session. If space is not set within the package session, this value should be provided. Ignored if id is set

spaceLayoutId

integer

optional

The id of the space layout associated with a booking package session. If space layout is not set within the package session, this value should be provided. Ignored if id is set

numberAttendees

integer

optional

The total attendees of the booking package.

agreedAttendees

integer

optional

The agreed attendees of the booking package, applicable and required when the venue setting "showAdditionalAttendees" is enabled.

expectedAttendees

integer

optional

The expected attendees of the booking package, applicable when the venue setting "showAdditionalAttendees" is enabled.

guaranteedAttendees

integer

optional

The guaranteed attendees of the booking package, applicable when the venue setting "showAdditionalAttendees" is enabled.

setAttendees

integer

optional

The set attendees of the booking package, applicable when the venue setting "showAdditionalAttendees" is enabled.

actualAttendees

integer

optional

The actual attendees of the booking package, applicable when the venue setting "showAdditionalAttendees" is enabled.

isAccommIncluded

integer

optional

Whether or not accommodation is included in the booking package.

smallDescription

string

optional

The small description of the booking package.

Example Request

{
    "id": 3948,
    "venueId": 1,
    "bookingId": 26806,
    "packageId": 49,
    "price": 1300,
    "bookingDate": "2025-03-22",
    "numberAttendees": 5,
    "isAccommIncluded": true,
    "smallDescription": "test",
    "mainSpaceVenueId": 1,
    "mainSpaceId": 1,
    "spaceLayoutId": 1,
    "costcenters": [
        {
            "id": 1,
            "value": 130,
            "excludedTaxIds": null
        },
        {
            "id": 2,
            "value": 1170,
            "excludedTaxIds": []
        }
    ]
}

Returns

Property
Description

success

Whether or not the booking package is added/updated to the booking

id

The unique id of the booking package

warnings

Warning messages that can occur on success

Throws

Code
Description

Specific Code: 23026

The booking does not exist

Specific Code: 24458

The package does not exist

Specific Code: 24459

The booking package does not exist

Specific Code: 24460

An error has occurred

Specific Code: 24461

The request contains invalid data

Specific Code: 24462

The request contains invalid data

Costcenter

Property
Type
Required
Description

id

integer

required

The costcenter identifier

value

double

required

The cost per person for the costcenter

excludedTaxIds

optional

array of integers

The taxe ids excluded from the costcenter

Response Warnings

Value
Description

packageSessionErrors

One or more sessions of the event template could not be added to the booking. This is usually caused by conflicting reservations on function space.

PreviousAdd or Update Opportunity NoteNextGet Booking Document List

Last updated 25 days ago

array of

Costcenter