List Combo Templates
GET /v1/combo/event/templates
inputs:
- startTime: (optional) only return combo templates that end after startTime
- endTime: (optional) only return combo templates that start before endTime
- eventTemplateId: (optional) only return combo templates that contain the specified event template.
returns:
A list of combo templates
Get Combo Template
GET /v1/combo/event/templates/{templateId}
returns:
The Combo Template associated with the specified id.
Create a Combo Template
POST /v1/combo/event/templates
returns:
The newly created combo template with the id filled in.
Update a Combo Template
PUT /v1/combo/event/templates
returns:
The updated Combo Template.
Delete a Combo Template
DELETE /v1/combo/event/templates/{templateId}
returns:
The Combo Template of the deleted entry.
Combo Template JSON Objects
Field | Description | Notes |
|---|---|---|
| id | A unique ID for this combo template. | Read Only |
| type | the combo template type (fixedPrice or discountCode) | |
| name | The name of this combo template. | Required |
| capacity | The capacity for this combo template. | Required |
| description | A description of this combo template. | Required |
| summary | A summary of the combo template, if not provided we will use the first 300 characters of the description. | |
emailConfirmationMessage | A message to be added to the emails sent to customers when they purchase events of this template. | |
reviewState | The review state of the combo template, one of (Draft or Published). Keep it in Draft mode until you are done editing and ready to start offering in our consumer pages then flip it to Published state. | |
| startTime | The time that this combo will start being available. | |
| endTime | The time that this combo will no longer be available. | |
| templates | A list of event templates available in this combo template. | |
| templates.entries | The list of entries in this combo template. | |
| templates.entries[x].type | The type of entry, one of (Event or Any). Use type Any for combos like (any two of these five events), use Event when the single event is required. | |
| templates.entries[x].templateId | Single template id for when doing an 'Event' type. | |
| templates.entries[x].templateIds | List of template Ids when dong an 'Any' type. | |
| templates.entries[x].quantity | The number of these events that are required. Used for 'Any' type for cases of (any two of these five events). | |
| templates.entries[x].revenueAllocation | The percentage of the revenue associated with this entry. If you have three entries and their revenue allocations are 50%, 25% and 25% and the price is $20 then the first entry will have a value of $10 and the other two $5. This is mostly for accounting but also used for refunds. | |
| templates.entries[x].schedule | Used for Event type, if this combo is limited to a single schedule of an event then this is the schedule id of that schedule. | |
| addOns | A list of add ons available in this combo template. | |
| addOns[x].addOnId | The id of the add on that's available for this combo. | |
| addOns[x].quantity | Number of add ons that can be purchased at this price. | |
| addOns[x].price | price per unit if priceSplit is 'each' or total for this quantity if 'exactly'. | |
| addOns[x].quantityType | Either 'any' or 'exactly'.
| |
| addOns[x].priceSplit | Either 'each' or 'total'
| |
| salesChannels | A list of sales channels that this sales channel is available on. | |
| priceList | The price list for this combo. | |
| discountId | The discount Id linked to the combo event template. | |
discountDistributionType | Used to apply a discount on the purchased combo event. The discount can either be applied to price for each event or to the total amount. takes (each or total). | |
discount | The discount object for the combo template. More information can be found here |
Sample JSON
Sample JSON
{ "addOns": [ { "addOnId": 1917148696116300331, "price": "0.10", "priceSplit": "each", "quantity": 8, "quantityType": "any" }, { "addOnId": 651307225029490436, "price": "0.10", "priceSplit": "each", "quantity": 1, "quantityType": "any" }, { "addOnId": 7038354680061489649, "price": "0.10", "priceSplit": "each", "quantity": 8, "quantityType": "any" } ], "capacity": 88, "description": "1b3c1252-a048-4501-98ac-0c88096118dc", "emailConfirmationMessage": "bcbabb2a-3a8c-4a6d-be65-bc9a43533eda", "endTime": "2015-02-20T23:59:59-05:00", "id": "b767e499-0dfa-42a5-a6e9-c678e14a4552", "name": "bc8f1235-4de0-4d63-971d-1e7bfe243292", "reviewState": "DRAFT", "shortDescription": "568cc50a-baab-42d8-b338-f9f8be7639ae", "startTime": "2015-02-20T00:00:00-05:00", "summary": "226a6cf2-f4d2-4db9-a81e-383c7c9d368e", "templates": { "entries": [ { "quantity": 0, "revenueAllocation": 0.0, "schedule": "4d3ab027-8433-4316-a038-6167c5d399a8", "templateId": "62011eae-940f-446b-be41-099523e91559", "type": "event" }, { "quantity": 0, "revenueAllocation": 0.0, "schedule": "c80769e7-6de8-4d8a-b4c2-99d03b40a1af", "templateId": "ac9c5e45-c27e-4b4c-9576-a6a59029cfdb", "type": "event" }, { "quantity": 0, "revenueAllocation": 0.0, "schedule": "8fae0b03-9980-4172-8536-622232d9921d", "templateId": "6cbd7c6e-9d2b-4b5b-b92f-4f35225bb3d4", "type": "event" } ] }} |