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
    • 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
Powered by GitBook
On this page
  • Get Venue Package (Event Template) List
  • Example Request
  • Returns
  • Cost Center
  • Cost Center Discount
  • Package Type
  • Price Method
  1. Venue
  2. Venue Setup Data

Get Venue Package List

Get Venue Package (Event Template) List

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

Provides the list of packages (Event Templates)

Request Body

Name
Type
Description

venueId

integer

The id of the venue

{
    "meta": {
        "totalResults": 1,
        "start": 0,
        "perPage": 100,
        "count": 1
    },
    "results": [
        {
            "id": 1,
            "name": "Standard",
            "type": 1,
            "minPax": 1,
            "maxPax": 1000,
            "cost": 500,
            "priceMethod": 1,
            "actualCost": 50,
            "actualCostExcludedTaxIds": [
                1,
                317,
                1046,
                1203,
                1204,
                1955,
                1986,
                1988,
                3910,
                3979
            ],
            "smallDescription": "Standard",
            "largeDescription": "<p>Standard</p>\n",
            "marketplaceName": "Standard",
            "isVisibleOnVenueSearch": false,
            "createdDate": "2017-12-18 12:23:53",
            "modifiedDate": "2025-04-23 23:28:28",
            "startDate": null,
            "endDate": null,
            "startTime": "06:00:00",
            "endTime": "12:30:00",
            "costcenters": [
                {
                    "id": 1,
                    "value": 149.5,
                    "excludedTaxIds": [
                        1,
                        317,
                        1955
                    ]
                },
                {
                    "id": 2,
                    "value": 100,
                    "excludedTaxIds": []
                },
                {
                    "id": 3,
                    "value": 100.5,
                    "excludedTaxIds": [
                        3910,
                        3979
                    ]
                },
                {
                    "id": 4,
                    "value": 100,
                    "excludedTaxIds": []
                },
                {
                    "id": 5,
                    "value": 0,
                    "excludedTaxIds": []
                },
                {
                    "id": 1166,
                    "value": 0,
                    "excludedTaxIds": []
                },
                {
                    "id": 2986,
                    "value": 50,
                    "excludedTaxIds": []
                },
                {
                    "id": 6338,
                    "value": 0,
                    "excludedTaxIds": []
                },
                {
                    "id": 17647,
                    "value": 0,
                    "excludedTaxIds": []
                },
                {
                    "id": 17648,
                    "value": 0,
                    "excludedTaxIds": []
                },
                {
                    "id": 17649,
                    "value": 0,
                    "excludedTaxIds": []
                }
            ],
            "hasSessions": true,
            "spaceId": 1,
            "spaceLayoutId": 2,
            "spaceCustomLayoutName": "C",
            "sortOrder": 0,
            "excludedFromCommissions": false,
            "reduceRoomHireFirst": true,
            "eventTypes": [
                1,
                2,
                3,
                4,
                5,
                6
            ],
            "userGroupIds": [
                1,
                2
            ],
            "hasLimitedStartTimes": true,
            "limitedStartTimes": [
                "02:30:00",
                "03:00:00"
            ],
            "isAccommIncluded": true,
            "discountCampaignId": 59,
            "costcentersDiscounts": [
                {
                    "id": 1,
                    "value": 18
                },
                {
                    "id": 2,
                    "value": 18
                },
                {
                    "id": 3,
                    "value": 18
                },
                {
                    "id": 4,
                    "value": 18
                },
                {
                    "id": 5,
                    "value": 18
                },
                {
                    "id": 6338,
                    "value": 18
                },
                {
                    "id": 2986,
                    "value": 18
                }
            ]
        }
    ]
}

Example Request

getVenuePackageList

{
    "venueId": 1,
    "perPage": 2
}

Returns

A collection object with the following properties in the results

Property
Data Type
Description

id

integer

The unique identifier of the package

name

string

The name of the package

type

Simple or Detailed

minPax

integer

The minimum pax of the package

maxPax

integer

The maximum pax of the package

cost

float

The price of the package (depends on the "priceMethod" value)

priceMethod

The type of package price - per person or flat rate

actualCost

float

The actual cost of the package

actualCostExcludedTaxIds

array

The tax ids excluded from the actual cost

smallDescription

string

A html formatted small description of the package

largeDescription

string

A html formatted large description of the package

marketplaceName

string

The name of the package displayed in marketplace booking engines

isVisibleOnVenueSearch

boolean

Whether the package is visible on venue search

createdDate

datetime

The date and time the package was created

modifiedDate

datetime

The date and time the package was last modified. Does not include changes to the package items

startDate

date

The date from which the package is available

endDate

date

The date to which the package is available

startTime

time

The time from which the package is available

endTime

time

The time to which the package is available

costcenters

The cost centers to which the package applies.

hasSessions

boolean

Whether the package has sessions

spaceId

integer

The default space to be used for the package

spaceLayoutId

integer

The default space layout to be used for the package

spaceCustomLayoutName

string

Layout name for custom space layout

sortOrder

integer

The order in which the package should be displayed

excludedFromCommissions

boolean

Whether the package is excluded from commissions

reduceRoomHireFirst

boolean

Whether to reduce room hire first when applying the package to bookings

eventTypes

array

The marketplace event types to which the package applies. If empty, the package applies to all event types

userGroupIds

array

The user groups to which the package applies. If empty, the package applies to all user groups

hasLimitedStartTimes

boolean

Whether the package has limited start times

limitedStartTimes

time

The limited start time of the package

isAccommIncluded

boolean

Whether accommodation is included in the package. This is a legacy field and should not be used

discountCampaignId

integer

The discount campaign to apply to the package

costcentersDiscounts

The cost center discounts to apply to the package

Cost Center

Property
Data Type
Description

id

integer

The cost center identifier

value

float

The discount percentage for the cost center

Cost Center Discount

Property
Data Type
Description

id

integer

The cost center identifier

value

float

The price for the cost center

Package Type

Identifier
Description

1

Detailed

2

Simple

Price Method

Identifier
Description

1

Per Person

2

Flat Rate

PreviousGet Space Hire PlansNextGet Venue Package

Last updated 15 days ago

enum

enum

array of

array of

The result from this call will be a of all the events the user has access to. This call also accepts the and properties.

collection
pagination
filter
PackageType
priceMethod
CostCenter
Cost Center Discounts