Page Comparison

Table of Contents

minLevel	1
maxLevel	6
outline	false
style	disc
type	list
printable	true

Overview

The getVoucherInformation operation will return detailed information about a properties voucher account, along with details of any vouchers/tickets configured in the IBE.

Request

Element	Type	Description
siteIDList	Array	(Mandatory) A list of property IDs for which voucher information should be returned. This must be a subset of properties that are enabled for your API.
options		Specify one or more of the available options to determine what information is returned in the response. List of Options

Sample

Code Block

language	json

{
    "userAuth": {
        "username": "username",
        "password": "password"
    },
    "operation": "getVoucherInformation",
    "siteIDList": [
        1853
    ],
    "options": [
        "fullPropertyInformation",
        "voucherInformation",
        "ticketInformation",
        "imageInformation"
    ]
}

Options

Option	Type	Description
fullPropertyInformation	String	Property information including name, address, geolocation, facilities and other property configuration options.
voucherInformation	String	Full voucher including title, description, images pricing and URL.
ticketInformation	String	Full ticket information including title, description, images and URL.
imageInformation	String	If this option is specified in conjunction with the voucherInformation or ticketInformation options, full image information will be returned in the response.

Response

Element				Type	Description
siteList				Array	The siteList array will contain an entry for each site as requested in the siteIDList section of the request.
	siteID			Integer	The internal IBE siteID for the property.
	primaryName			String	Property name.
	address			String	Property address.
	phone			String	Property phone number.
	fax			String	Property fax number.
	url			String	Property website url.
	email			String	Property email address.
	voucherList			Array	The voucherList array will contain an entry for each voucher available for sale.
		title		String	The title of the voucher.
		description		String	The description of the voucher.
		category		String	The voucher category
		images		Array	An array of images associated with the voucher.
			groupID	Integer	The internal groupID of the image in the IBE.
			size	String	The height x width dimensions of the image.
			url	String	The URL for where the image is stored.
		prices		Array	An array of images associated with the voucher.
			type	String	The price type of the voucher. This can be one of 2 values, "fixedValue" or "dynamicValue".
			minValue	Integer\|Float	The minimum monetary value that this voucher can be sold for.
			maxValue	Integer\|Float	The maximum monetary value that this voucher can be sold for.
			stepValue	Integer\|Float	The stepValue can be used in conjunction with the minValue and maxValue to determine the monetary sale amounts for dynamic value vouchers.
			strikeValue	Integer\|Float	This can be used to indicate that the sale price of a voucher is struck through from a higher price giving the indication that the voucher is on sale or special offer.
			totalQuantity	Integer\|NULL	The total quantity of this voucher available to be sold.
			totalQuantitySold	Integer\|NULL	The total quantity of this voucher already sold.
			startSell	String	This can be used to indicate the beginning of a sell date restriction period.
			endSell	String	This can be used to indicate the end of a sell date restriction period.
			maxPerSale	Integer	This can be used to limit the number of vouchers that can be purchased in one transaction.
		url		String	The direct link to this voucher in the IBE.
	ticketList			Array	The ticketList array will contain an entry for each ticket available for sale.
		type		String	The price type of the ticket. This can be one of 2 values, "fixedValue" or "dynamicValue".
		minValue		Integer\|Float	The minimum monetary value that this ticket can be sold for.
		maxValue		Integer\|Float	The maximum monetary value that this ticket can be sold for.
		stepValue		Integer\|Float	The stepValue can be used in conjunction with the minValue and maxValue to determine the monetary sale amounts for dynamic value tickets.
		strikeValue		Integer\|Float	This can be used to indicate that the sale price of a ticket is struck through from a higher price giving the indication that the ticket is on sale or special offer.
		totalQuantity		Integer\|NULL	The total quantity of this ticket available to be sold.
		totalQuantitySold		Integer\|NULL	The total quantity of this ticket already sold.
		startSell		String	This can be used to indicate the beginning of a sell date restriction period.
		endSell		String	This can be used to indicate the end of a sell date restriction period.
		maxPerSale		Integer	This can be used to limit the number of tickets that can be purchased in one transaction.
		tiers		Array	An array of pricing tiers that apply to this ticket.
			titleShort	String	The short title of the price tier.
			titleLong	String	The long title of the price tier.
			description	String	The description of the price tier.
			unitValue	Integer\|Float	The monetary value that this ticket price is to be sold for on this tier.
			strikeValue	Integer\|Float	This can be used to indicate that the sale price of a ticket is struck through from a higher price giving the indication that the ticket is on sale or special offer.
			totalQuantity	Integer\|NULL	The total quantity of this ticket available to be sold on this tier.
			totalQuantitySold	Integer\|NULL	The total quantity of this ticket already sold on this tier.
			maxPerSale	Integer	This can be used to limit the number of tickets that can be purchased on this tier in one transaction.
			startSell	String	This can be used to indicate the beginning of a sell date restriction period.
			endSell	String	This can be used to indicate the end of a sell date restriction period.
		url		String	The direct link to this ticket in the IBE.

Voucher Price Types

Price Type	Description
fixedValue	Fixed value vouchers have one single monetary value assigned to it.
dynamicValue	Dynamic value vouchers/tickets can vary in monetary value, used in conjunction with the stepValue to determine the price points available.
perPersonValue	Per person priced vouchers will charge the assigned monetary value for the number of people selected.

Ticket Price Types

Price Type	Description
fixedValue	Fixed value tickets have one single monetary value assigned to it.
tiersValue	Tiers value tickets will have one or more tiers configured, each tier will have a separate price point.
perPersonValue	Per person priced tickets will charge the assigned monetary value for the number of people selected.

Sample

Code Block

language	json

{
  "siteList": [
    {
      "siteID": 1853,
      "primaryName": "TestHotel Mahony",
      "address": "Avvio House, Lonsdale Road, National Technology Park, Castletroy, Co. Limerick V94 AW2X",
      "phone": "+353-61-335680",
      "fax": "",
      "url": "http://www.shrgroup.com",
      "email": "martin.mahony@shrgroup.com",
      "voucherList": [
        {
          "title": "Test Voucher",
          "description": "this is a test voucher",
          "category": "",
          "images": [
            {
              "groupID": 3381,
              "size": "120x90",
              "url": "d1ge8a3d73odmf.cloudfront.net/053/026/000/3381/120x90.jpg"
            },
            {
              "groupID": 3381,
              "size": "400x300",
              "url": "d1ge8a3d73odmf.cloudfront.net/053/026/000/3381/400x300.jpg"
            },
            {
              "groupID": 3381,
              "size": "800x600",
              "url": "d1ge8a3d73odmf.cloudfront.net/053/026/000/3381/800x600.jpg"
            }
          ],
          "prices": [
            {
              "type": "perPersonValue",
              "minValue": 250,
              "maxValue": 250,
              "stepValue": 0,
              "strikeValue": 0,
              "totalQuantity": 78,
              "totalQuantitySold": 38,
              "startSell": "2000-01-01",
              "endSell": "2999-12-31",
              "maxPerSale": 0
            }
          ],
          "url": "https://dev.avvio.com/vouchers/site/TestHotel%20Mahony/en/index/voucher/8796093022466.html"
        }
      ],
      "ticketList": [
        {
          "title": "Test Ticket",
          "description": "this is a test ticket",
          "images": [
            {
              "groupID": 1711,
              "size": "120x90",
              "url": "d1ge8a3d73odmf.cloudfront.net/047/013/000/1711/120x90.jpg"
            },
            {
              "groupID": 1711,
              "size": "400x300",
              "url": "d1ge8a3d73odmf.cloudfront.net/047/013/000/1711/400x300.jpg"
            },
            {
              "groupID": 1711,
              "size": "800x600",
              "url": "d1ge8a3d73odmf.cloudfront.net/047/013/000/1711/800x600.jpg"
            },
            {
              "groupID": 3295,
              "size": "120x90",
              "url": "d1ge8a3d73odmf.cloudfront.net/095/025/000/3295/120x90.png"
            },
            {
              "groupID": 3295,
              "size": "400x300",
              "url": "d1ge8a3d73odmf.cloudfront.net/095/025/000/3295/400x300.png"
            }
          ],
          "prices": [
            {
              "type": "fixedValue",
              "minValue": 300,
              "maxValue": 300,
              "stepValue": 0,
              "strikeValue": 0,
              "totalQuantity": null,
              "totalQuantitySold": null,
              "startSell": "2000-01-01",
              "endSell": "2999-12-31",
              "maxPerSale": 0,
              "tiers": [
                {
                  "titleShort": "Standing",
                  "titleLong": "Standing Ticket",
                  "description": "The standing section is our cheapest option",
                  "unitValue": 49,
                  "strikeValue": 0,
                  "totalQuantity": 15,
                  "totalQuantitySold": 0,
                  "maxPerSale": 4,
                  "startSell": null,
                  "endSell": null
                },
                {
                  "titleShort": "General",
                  "titleLong": "General Seating",
                  "description": "The public seating section is our mid-range option",
                  "unitValue": 65,
                  "strikeValue": 0,
                  "totalQuantity": 20,
                  "totalQuantitySold": 1,
                  "maxPerSale": 4,
                  "startSell": null,
                  "endSell": null
                },
                {
                  "titleShort": "Private",
                  "titleLong": "Private Seating",
                  "description": "The private seating section is our most expensive option",
                  "unitValue": 80,
                  "strikeValue": 0,
                  "totalQuantity": 20,
                  "totalQuantitySold": 0,
                  "maxPerSale": 4,
                  "startSell": null,
                  "endSell": null
                }
              ]
            }
          ],
          "url": "https://dev.avvio.com/vouchers/site/TestHotel%20Mahony/en/index/voucher/8796093022470.html"
        }
      ]
    }
  ]
}

...

Versions Compared

Old Version 1

New Version Current

Key

Overview

Request

Sample

Options

Response

Voucher Price Types

Ticket Price Types

Sample