List

Get /v1/b2b/discounts

Returns

A list of Discount JSON Objects


Get

Get /v1/b2b/discounts/{id}

Inputs

id: the id of the discount

Returns

A Discount JSON Object associated with the id.


Get a discounted price list

Get /v1/b2b/discounts/{id}/price/list/{priceListId}

Inputs

id: the id of the discount

priceListId:  the id of the price list you want discounted.

Returns

An Event Price List JSON Object


Create

Get /v1/b2b/discounts

Body

A Discount JSON Object

Returns

The id of the newly created discount.


Update

Get /v1/b2b/discounts/{id}

Inputs

id:  the id of the discount you are updating.

Body

A Discount JSON Object

Returns

A Discount JSON Object with the updated values.


Delete

Get /v1/b2b/discounts/{id}

Inputs

id: id of the discount you are deleting.

Returns

A Discount JSON Object of the deleted discount.

 

JSON Objects

Discount JSON Object

Field
Description
Notes
idThe unique id of this discount. 
code  
nameThe name of the discount. 
descriptionThe description of the discount. 
valuesA list of values for the discount. 
values[x].personTypeIdThe ticket type for this discount. 
values[x].personTypeThe person type objectRead Only
values[x].personType.nameThe name of the person type. Like 'Adult'.Read Only
values[x].personType.descriptionThe description of the person type. Like '13 and older'Read Only
values[x].personType.typeGroup or ComboRead Only
values[x].personType.activeWhether the person type is active or not (true or false)Read Only
values[x].personType.displayOrderWhere this person type should be displayed when presenting to a customer.Read Only
values[x].personType.childrenThe list of child person types associated with this person type. If this person type is a family ticket and has two Adult and two Child tickets then it would have two children. One Adult with a quantity 2 and one Child with quantity 2.Read Only
values[x].personType.children[y].personTypeIdThe type of ticket belonging to the parent ticket type. If this person type is a family ticket and has two Adult and two Child tickets then it would have two children. One Adult with a quantity 2 and one Child with quantity 2.Read Only
values[x].personType.children[y].quantityThe number of these ticket types belonging to the parent ticket type. If this person type is a family ticket and has two Adult and two Child tickets then it would have two children. One Adult with a quantity 2 and one Child with quantity 2.Read Only
values[x].discountTypeThe type of discount, either a percentage discount (PercentageBased), like 10% off, or an actual dollar amount discount (AmountBased), like $2 off. 
values[x].valueThe numeric value for the amount off. If it is a 10% off then this value would be 10. If the discount is a $5 off then this value would be 500. 

 

Event Price List JSON Object

Field
Description
Notes
 priceListIdThe id of the price list being discounted. Read Only
 pricesThe list of  prices.Read Only
prices[x].personTypeIdThe ticket type for this discount.Read Only
prices[x].personTypeThe person type objectRead Only
prices[x].personType.nameThe name of the person type. Like 'Adult'.Read Only
prices[x].personType.descriptionThe description of the person type. Like '13 and older'Read Only
prices[x].personType.typeGroup or ComboRead Only
values[x].personType.activeWhether the person type is active or not (true or false)Read Only
prices[x].personType.displayOrderWhere this person type should be displayed when presenting to a customer.Read Only
prices[x].personType.childrenThe list of child person types associated with this person type. If this person type is a family ticket and has two Adult and two Child tickets then it would have two children. One Adult with a quantity 2 and one Child with quantity 2.Read Only
prices[x].personType.children[y].personTypeIdThe type of ticket belonging to the parent ticket type. If this person type is a family ticket and has two Adult and two Child tickets then it would have two children. One Adult with a quantity 2 and one Child with quantity 2.Read Only
prices[x].personType.children[y].quantityThe number of these ticket types belonging to the parent ticket type. If this person type is a family ticket and has two Adult and two Child tickets then it would have two children. One Adult with a quantity 2 and one Child with quantity 2.Read Only
prices[x].priceThe discounted price for this person type.Read Only
prices[x].salesChannelsThe list of sales channels available for this price. See Price List Sales Channels for more information.Read Only
prices[x].salesChannels[y].nameThe name of the sales channel.Read Only
prices[x].salesChannels[y].channelThe channel.Read Only
prices[x].salesChannels[y].enabledtrue if you can buy via this sales channel otherwise false.Read Only