JUMP TOAuthorisation HeaderAuth header testgetWidgets/widgetspostTable of contentsPage 1Page 2Page 3Required path paramsTest removing required labelgetSwagger PetstorepetAdd a new pet to the storepostUpdate an existing petputFinds Pets by statusgetFinds Pets by tagsgetFind pet by IDgetUpdates a pet in the store with form datapostDeletes a petdeleteuploads an imagepoststoreReturns pet inventories by statusgetPlace an order for a petpostFind purchase order by IDgetDelete purchase order by IDdeleteuserCreate userpostCreates list of users with given input arraypostCreates list of users with given input arraypostLogs user into the systemgetLogs out current logged in user sessiongetGet user by user namegetUpdated userputDelete userdeleteBasic AuthBasic auth no passwordgetYian's 404 API200get404getTest manualTestgetTest manualPostpostRedirect APIRedirect testgetreadme.io updated 2/getgetSwagger/swaggerpost/swagger/{id}put/swagger/{id}deleteTest image in html blockTest image in html blockgetTicketSocket.ApiAccountsV1Returns the user name and the identity of the login provider for the current user.get/api/accounts/logoutpostCreates a Password reset code for the user with the provided Email Address and sends an Email to the UserpostUpdates a logged in user's password.postResets the User's password by verifying the Email Address and random code. and accepting the new password.postResets the Super Admin's password. and accepting the new password.postChanges user password.post/api/accounts/set-passwordpostRegisters a Super Admin within the System.postRegisters a Sales Rep into the system.postRegisters a Customer in the system.postAffiliatesV1Activates affiliate tracking code.putLists the affiliates for a given site.getAdds an affiliate to the parent company of the Site where the Affiliate is added. Affiliates are always added at the parent company level so that they can be shared among sites.postGets the affiliate by its Id.getUpdates an affiliate to the parent company of the Site where the Affiliate is added. Affiliates are always added at the parent company level so that they can be shared among sites.putClones a affiliate by copying Name, Parent Affiliate and Tracking Codes if exist.postLists the codes for a given affiliate.getAdds an affiliate Tracking code to the model.postGets the Affiliate code by Id.getUpdates an affiliate Tracking code to the model.putAdds priced event assignments for a given Affiliate Code.postArchives affiliate tracking code.putArchives an Affiliate assigned to a given Site. This doesn't archive the Affiliate itself. It only archives the relationship of the Affiliate to the site.putAssigns an existing Affiliate to the Site.postBlacklists an event from the Affiliate Code.postDeactivates affiliate tracking code.putUpdates the existing Blacklisted Event's criteria.putRemoves a blacklisted event from the list.deleteUpdates the Exclusive Event Assignment by the Event Id.putRemoves an Event Assignment from an Affiliate code.deleteRestores affiliate tracking code.putRestores a previously archived Site Affiliate assignment.putAdds tiered commissions for a given code.postLists an Affiliate's Admins.getAdds an Affiliate Admin if one isn't already added. Administrators should be globally unique within the system.postActivates a previously deactivated Affiliate Admin.putDeactivates an Affiliate Admin.putArchives an Affiliate Admin.putRestores a previously archived Affiliate Admin.putGets Affiliates Statistics.getGets Statistics for an Affiliate.getGets Affiliates Graph.getGets Graph for an Affiliate.getGets Affiliates Orders.getGets Orders for an Affiliate.getGets Affiliates Report.getGets Report for an Affiliate.getApiClientsV1Adds an API Key for a given User.postAdds a new api client.postBillingRulesV1Gets the Company's Ticket Billing Rules.getAdds the Company level Ticket Billing Rules.postUpdates the Ticket Billing Rule.putArchives the Ticket Billing RuledeleteRestores the Ticket Billing RuleputGets the Site's Ticket Billing Rules. If the Site doesn't directly have billing rules associated with it, then gets the parent Company's rules.getAdds a site billing rule.postBillingServiceV1Gets the Orders to bill.getGets the Billing Summary for a given Site based on the from/to date ranges.getGets the Billing Report for a given site.getGenerates a billing report for the Site for the given Date range.postBoxOfficeV1Gets the Box Office Settings for a Logged In User.getBulkDiscountsV1Gets list of Single Event Bulk Discount Rules.getAdds Single Event Bulk Discount Rule.postGets Single Event Bulk Discount Rule.getUpdates Single Event Bulk Discount Rule.putDeletes Single Event Bulk Discount Rule.deleteActivates Single Event Bulk Discount Rule.putDeactivates Single Event Bulk Discount Rule.putArchives Single Event Bulk Discount Rule.putRestores Single Event Bulk Discount Rule.putAdds/Updates Quantity Qualifier for a Single Event Bulk Discount Rule.postDeletes Quantity Qualifier for a Single Event Bulk Discount Rule.deleteAdds/Updates Tier Qualifier for a Single Event Bulk Discount Rule.postDeletes Tier Qualifier for a Single Event Bulk Discount Rule.deleteAdds/Updates Quantity Discount for a Single Event Bulk Discount Rule.postDeletes Quantity Discount for a Single Event Bulk Discount Rule.deleteAdds/Updates Tier Discount for a Single Event Bulk Discount Rule.postDeletes Tier Discount for a Single Event Bulk Discount Rule.deleteCompaniesV1Gets a flattened list of Domains that belong to the company.getAllows Administrators of the System to list the Companies within the system.getAllows an administrator to Add a Company.postGets the Company by Id.getUpdates the Company information.putGets a list of Company administrators.getAllows Administrators to add a Company Administrator. A company administrator can manage all companies under the current company's hierarchy.postGets company admin by userId.get/api/companies/{companyId}/archiveput/api/companies/{companyId}/restoreputList child companies for a given parent Company.getAdds a Child Company under a given company.postGetting the list of company addresses.getAdds an Address of a given Company.postGets the Company Address by Id.getUpdates the Company Address.putLists the Company's UsersgetArchives a Company User.putRestores a user.put/api/companies/users/{userId}/infoputAllows an administrator or super admin to change password of its members.postChanges a Company's Parent.putGets the Company Plugs by Site Id.getInstalls plug for the given Company Id.postActivates the Plug for the Company Id.putDeactivates the Plug for the Company Id.putGets company logo information.getUploads a logo for a company.postDeletes company logo.deleteGets the Company Contacts.getAdds a Company Contact.postGets a Company Contact by Id.getUpdates a Company Contact.putDeletes the Company Contact by a Contact Id.deleteActivates a company Contact.putDeactivates a Company Contact.putArchives a Company Contact.putRestores a previously archived Company Contact.putCustomFieldGroupsV1Gets Custom Field Groups by Field Usage.getAdds Custom Field Group.postUpdates Custom Field Group.putAdds Field Assignment.postUpdates Field Assignment.putReorders the Custom Field Groups in the Order provided.putReorders the Custom Field assignments in the Order provided.putGets Custom Field Group based on the Field Group Id.getGets Custom Field Groups.getGets field assignments based on Custom Field Group Id.getRemoves field assignment from the Custom Field Group.deleteArchives Custom Field Group.putRestores Custom Field Group.putVerifies if the slug is already in use or not.getDomainsV1Searches the Domain information by Domain name.getValidates the Domain name and checks for unqiueness.postGets the plugs by domain.getGets the logo by domain.getGets the root company for the domain name.getEventBookingsV1Gets the booking calendar for the GTO for a given Date Range.getGets the Booking Summary Report.getGets the Event's Time slot bookings/orders.getGets the Ticket Types for all the Time slots in the given day.getGets the mapped Ticket Types (and corresponding tiers) for a Time Slot.getGets the Occurrence Inventory.getNEW METHOD - Brings back the Time Slot's ticket type mappings with the time slot info and the inventory.getChecks if the inventory is available for a given time slot for a given Event.getChecks the transfer availability and returns the occurrences with the availability.postEventBundlingV1Adds the Tier bundling criteria.postEventFeesV1Gets the Event's Fees.getAdds a service fee for a given event.postClones fees from an existing Event.postGets the Event Fee by Id.getUpdate Fee by Id.putAdds Fee Ticket Type Assignments.postArchives the Event Fee.putRestores a previously archived Event Fee.putUpdates the Fee Ticket Type Assignments.postEventOptionsV1Clones an Event and its Ticket Types.postEventPackagesV1Lists candidate events to add to a Package Event.getGets event packages for a given site.getAdds an event package.postGets Packaged Sub Events.getAdds sub events to event packagepostGets Packaged Sub Event.getUpdates sub event.putDeletes Packaged Sub Event.deleteSets Main Attraction as true/false.putGets Package Tier Assignments.getAdds Package Tier Assignments along with optional Advanced Options.postGets Single Package Tier Assignment.getUpdates Package Tier Assignments along with optional Advanced Options.putDeletes Single Package Tier Assignment.deleteGets Package Section Assignments.getAdds Package Section Assignments.postGets Package Section Assignment with Seat Information.getUpdates Package Section Assignment.putDeletes Single Package Section Assignment.deleteAdds Package Row Assignments.postAdds seats to Row Assignment.postDeletes Single Package Row Assignment.deleteDeletes Single Seat from Row Assignment.deleteEventPreSalesV1Gets the PreSales for an event.getAssign preSales to an eventpostGets an Event Pre Sale by IdgetUpdates an existing PreSaleputActivate an event preSaleputDeactivate an event preSaleputArchive an event preSaleputRestore an archived event preSaleputEventProductAssignmentsV1Gets a list of products assigned to an Event.getAdds Event products.postArchives a Product from a given ticket tier for a given event.putArchives a Product from all Tiers for a given event.putRestores a Product for a given ticket tier for a given event.putRestores a Product for all Tiers for a given event.putDeactivates a Product from a given ticket tier for a given event.putDeactivates a Product from all Tiers for a given event.putActivates a Product for a given ticket tier for a given event.putRestores a Product for all Tiers for a given event.putEventQuestionsV1Gets the Attendee Questions assigned for the Event and its Tiers.getGets the Purchaser Questions assigned for the Event and its Tiers.getRemoves the Attendee Question Group assignment from a tier.postRemoves the Purchaser Question Group assignment from a tier.postAdds or Updates Tier Level Event Question assignments for the Purchaser.postAdds or Updates Tier Level Event Question assignments for the Purchaser.postEventRecurrencesV1Gets Event Time Slots.getAdds an Event Time Slot.postUpdates the Event Time slot.putArchives a Time Slot.putRestores a Time Slot.putGets the Event's Exception Dates.getAdds one or more Event Exception Date/Times.postRemoves one or more Event Exception Date/Times.deleteGets Sample Occurrences for a given Recurrence Pattern.postGets the Event Occurrences for a given date range. The from/to date ranges will always be capped of by the Recurrence Pattern from/to date ranges, or the Event's From/To Dates if present.getGets a Recurrence Pattern by Id.getAdds Additional Occurrences.postRemoves additional Occurrence dates from a given Recurrence Pattern.deleteGets the Pattern's additional occurrences by Date.getAdds one or more Ticket Type Assignments to a Pattern.postGets the Ticket Type assignments for a given pattern by time slot.getGets Event Recurrence Patterns. If 'includeArchived' is set to 'true', will return archived patterns as well.getAdds a yearly recurrence Pattern to an Event.postUpdates the yearly recurrence pattern for the Event.putAdds a monthly recurrence Pattern to an Event.postUpdates the monthly recurrence pattern for the Event.putAdds a Weekly recurrence Pattern to an Event.postUpdates the weekly recurrence pattern for the Event.putArchives the Recurrence Pattern.putRestores the Recurrence Pattern.putEventRegistrantsV1Gets the Event Registrants. If skipPaging is set to true, will get all records (primarily used for Exporting data in Excel format). Pass http accept header values as "Accept : application/vnd.ms-excel" to obtain an Excel export. Or alternatively, pass format query string parameter with a value "excel".getEventSeatingV1Activates the reserved hold.putGets the Reserved Holds.getAdds a Reserved Hold for one or more Sections.postGets the Ticket Type Section Assignments.getAdds the Ticket Type Section Assignments.patchGets the Tier Section Assignments.getAdds Section Assignments for a given tier.patchArchives reserved hold code.putGets the Blocked seats for a given Event.getBlocks section's rows or seats.postDeletes a given hold.postGets a Reserved Hold by IdgetUpdates the Reserved HoldputGets the Sales Matrix for a given section.getGets the Tiers assigned to the GA/Standing section.getMigrates the existing Seating Assignments to the new format.postRestores a reserved hold code.putDeactivates a reserved hold code.putGets the Venue stats for the given Event (and its occurrence if this is a recurring event).getGets the venue stats for the given Event (and its occurrence if this is a recurring event).getGets the seating stats for the given Event (and its occurrence if this is a recurring event).getGets the Pricing Setup for all sections for a given Venue for an event. If one or more sections aren't assigned, an incomplete status will be shown.getAssigns Section Pricing for a given Event.postGets a single Section's Event Pricing.getDeletes the Section's Pricing for a given Event.deleteGets the Section Reservations for a given Event.getEventsMediaV1Gets a List of PhotoInfo items for an Event.getUploads image for an Event.postGets a List photo for the Event.getUpload image for ListPhoto of EventpostDeletes a list photo for the Event.delete/api/sites/{siteId}/events/{eventId}/photos/{photoId}getDeletes a photo ojbect for an Event.deleteGets a list of Embedded Video's assigned to an Event.getAdds Embedded Video for an Event.postGet Embedded Video assigned to an Event by Video Id.getUpdate Embedded video for an Event.putDeletes embedded video from an Event.deleteEventsV1Sets the Event Order.postGets events for a given site.getAdds an eventpostGets previously Archived Events for a site.getGets the events that has passed the current date.getGets list of upcoming Events occuring after current date.getGet the Event Description for the given event id.getUpdates the Event Descriptions.putAdds the Event Description information like Long, Short descriptions and tags.postGets an Event by the Event Id.getUpdates an event.putUpdates the Event Currency Settings.putAdds or updates the Event's categories.postGets the Event's Tiers.getGets the Children Events for the specified Parent.getPublishes the Event and makes it active for purchasing tickets.putUn-publishes/de-activates an event so customers cannot purchase tickets.putSets an Event on sale.putSets an Event as a Featured Event.putResets an Event as a Featured Event.deleteSets an Event as not on sale.putHides an Event.putShows an Event.putGets the publishing options for the specified event Id.getArchives a given Event.putRestores a previously archived event.putGets payment processor assigned to eventgetAssign payment processor to an eventpostRemoves payment processor assigned to an event.deleteVerifies the Slug for uniqueness. A site cannot have events with duplicate URL slugs.postUpdates an Event's Slug.postGets Receipt setting details of the given eventId.getSaves the Receipt Settings.postUpdates the Event's Receipt Settings.putGet Ticket Shipping Option for EventIdgetAdds Ticket Shipping Option to Event.postUpdates Ticket Shipping options for the specified TicketShippingOptionTypeIdputDeletes TicketShippingOption for the given OptionTypeIddeleteGets the GA Event's Inventory. Will return an error if the Event is a Recurring Event.getFccV1Cancels an earlier request using the Merchant Reference Code associated with the original request.postParses the response from FCC and finalizes the Order if Payment was successful, or returns back the error message accordingly.postFglTemplatesV1Lists the Site's FGL Templates.getAdds the FGL Template to the Database.postGets the FGL template by id.getUpdates the FGL Template.putArchives FGL template.putRestores FGL template.putClones FGL template. Creates duplicate of current FGL template.postGets the Event's FGL Template SettingsgetSaves the Event's FGL Template model.postLists FGL commands for a template.getCreates FGL template command.postDeletes all FGL commandsdeleteGets a single FGL command.getUpdates FGL template command.putDeletes FGL template command.deleteSorts commands in a Sequence.postFieldsV1Gets a Field based on the Field Id.getGets a list of fields for the associated Usage Type.getSaves a Select Custom Field. Select Custom Field can be of Type Single/Multi based on the properties set in the object.postAdds free text custom field.postAdds toggle field custom field.postAdds Address fieldpostUpdates a AddressField.putUpdates Select Field.putUpdates a Toggle field.putUpdates the Text Field.putAdds answer option.postUpdates answer option.putDeletes a custom fieldpostDeletes an answer option.postVerifies if the question key is already in use or not.getGtoInvitationsV1Accepts the GTO Invite and creates the GTO and the GTO Admin's account.postLinks user account to GTO.postGets the Invited GTOs for a given Company.getInvites one or more GTO by Email Address and GTO Contact NamepostGets the Invited GTO for a given Company.getResends the GTO Invite to the email address associated.postGtoReservationActivitiesV1Gets the Reservation Activity broken down by occurrences within a given Date Range.getGtoReservationsV1Adds an event reservation.postPresents the GTO Reservation review.postFinalizes the GTO Reservation and generates all of the Occurrence Intervals.postActivates the GTO Reservation.postDeactivates the GTO reservation.postGets the GTO Reservation by Id.getGets the GTO Reservations for a given Site..getAdds exception dates to the Reservation.postReleases the Event's Reservation Occurrence for a given GTO.postReleases multiple reservations for the criteria specified.postGets the GTO allocated Recurrence Patterns for a given Event.getGets the Reservation's Selections and its available time slots (optionally).getAdds a Date selection to reservation.postAdds the Reservations's Time Slot Selections.postCreates the GTO Order.postGtoSetupV1Adds GTO event access setting.postInserts or updates the existing Daily GTO Quota.postGets the Events that a GTO can select from.getArchives the GTO Event setup.postRestores the GTO Event setup.postGets GTO event access setting time slots.getAdds GTO event access setting time slots.postAdds GTO event access setting ticket types.postAdds GTO event access setting tiers.postGets GTO event access setting with time slots, ticket types, tiers, date restrictions.getAdds or Updates the GTO purchase cutoff rules.postActivates GTO event access ticket type quota.postDeactivates GTO event access ticket type quota.postActivates GTO event access tier type quota.postDeactivates GTO event access tier type quota.postAdds pricing override to the tier.postAdds the pricing overrides for multiple tiers for a given setup.postUpdates GTO event access setting time slot quota.putUpdates GTO event access setting ticket type quota.putUpdates GTO event access setting tier quota.putDeletes GTO event access setting time slot selection.deleteDeletes GTO event access setting ticket type.deleteDeletes GTO event access setting tier.deleteAdds a Hourly recurrence date restriction.postAdds a Weekly recurrence date restriction.postAdds a Monthly recurrence date restriction.postAdds a Yearly recurrence date restriction.postUpdates a Hourly recurrence date restriction.putUpdates a Weekly recurrence date restriction.putUpdates a Monthly recurrence date restriction.putUpdates a Yearly recurrence date restriction.putGets Gto Event Access Setting Date Restrictions. If 'includeArchived' is set to 'true', will return archived restrictions as well.getAdds one or more GTO event access date restriction exception Date/Times.postDeletes GTO event access exception date.deleteArchive GTO event access date restriction.postRestore GTO event access date restriction.postGtosV1Gets the logged in User's GTO.getLists the GTOs for a given site.getGet the GTO By Id.getUpdates the GTO info.putActivates Gto admin.postDeactivates Gto admin.postGets GTO site setting.getAdds GTO billing schedule.postAdds GTO payment information.postUpdates the Payment info for the given Payment method.putAdds a per GTO allocation percentage quota.postInstallmentsV1Adds the Event Installment Options (mandatory/optional)postGets the Event's Installment plans.getAdds an Installment plan for the Event.postUpdates the Installment.putArchives the Installment.putRestores the Installment.putActivates the Installment Plan.putDeactivates the Installment Plan.putRegenerates Installments for an Order for which installments not generate.patchCharges the installment transaction manually.postRequeues a failed installment for processing.postGets the Orders with Failed installments.getInventoryStockV1Gets the Inventory Stock Items associated with a given Site.getKiccGets the Kicc's submission formpost/api/public/sites/{siteId}/orders/{orderId}/kiccpostMediaV1Allows to upload files like images, css, documents, etc.postAllows to upload files like images, css, documents, etc for company.postOccurrenceSettingsV1Updates multiple time slot inventories.postSaves or overrides an existing Occurrence inventory with the provided Inventory.postGets the Occurrence Inventory Overrides by Ticket Types.getArchives the Occurrence Inventory Status.postSaves the Occurrence On/Off Rules.postGets the Occurrence's On-Off Rules.getAdds TimeSlot Override.postDeletes Event Day Override.deletePublishes Time Slot OverrideputUnpublishes Time Slot OverrideputSets Time Slot Override on sale.putSets Time Slot Override not on sale.putLists Event Day Overrides.getGets Event Day Override for a Day.getDeletes Event Day Override.deleteOffersV1Gets the Offers for an event.getAssign offers to an eventpostGets an Offer by IdgetUpdates an existing OfferputActivate an event offerputDeactivate an event offerputArchive an event offerputRestore an archived event offerputAdds an Affiliate to the Exclusive Affiliate List.postOrdersV1Gets the Order list based upon the filter criteria.getFilters the Orders based on the criteria provided.postGets order based on the order Id. If HTTP headers are set with an accept type of 'text/fgl', then will return the Order's FGL that can be used for BOCA printing. If 'html' format or accept type of 'text/html' is used, then it will return the Order in HTML format.getGets order based on the order Id. If HTTP headers are set with an accept type of 'text/fgl', then will return the Order's FGL that can be used for BOCA printing. If 'html' format or accept type of 'text/html' is used, then it will return the Order in HTML format.getGets the Order Transfer history for a given order.getChecks in an entire Order and its tickets. If Event Id/Occurrence are passed, then will only check-in the tickets that match the criteria. For bundled tickets, will check in any companion tickets that match the criteria.postGets shipping information for the order.getUpdates information for the order.putUpdates the Purchaser Info.putGets billing information for the order.getUpdates billing information for the order.putGets line item (Ticket/Product) within order.getGets ticket information for the based on line item and order.getGets ticket information based on ticketId and order Id. If format is set to 'fgl' or HTTP Headers Accept type is set to 'text/fgl', then will return the FGL content for the ticket. If format is set to 'thermal' or HTTP Headers Accept type is set to 'application/pdf' will print Thermal/PDF tickets.getTransfers the line item from one time slot to another.postTransfers multiple line items from a given order to a new one.postGets Tickets for the order id.getCancels one or more of the Order's Tickets.postChanges the Card associated with the Order if there's an oustanding payment associated with the order.putSends the Email that allows a user to change their Card information.postRefunds an Order with a specific amountputSends the confirmation email.postResends the installment confirmation email.postGets the Order Transaction Info.getStartes the ticket transfer process by validating input and reserving new seats.postFinalizes the ticket transfer process by charging/refunding if needed and re-assigning seats.postCancels the ticket transfer process. Releases new seats and cancels the whole process.postProcesses the Order's Installments.postCalculates the Order's Billing.getDecrypts the Order.postOutletsV1Gets Outlets for a given site.getAdds an Outlet for a given site.postGets Outlet information for a given site.getUpdates an Outlet for a given site.putActivates an Outlet for a given site.putDeactivates an Outlet for a given site.putArchives an Outlet for a given site.putRestores an Outlet for a given site.putGets the Outlet's Event Assignments (both Exclusive and Blacklisted) for a given Site.getAdds an Outlet Level Event Assignment.postUpdates an Outlet Level Event Assignment.putDeletes a previously added Outlet Event Assignment.deleteAdds an Outlet Level Blacklisted Event Assignment.postUpdates an Outlet Level Blacklisted Event Assignment.putDeletes a previously added Outlet Blacklisting Event Assignment.deleteGets tracking codes for a given outlet.getAdds an outlet Tracking code to the site.postGets the Outlet code by Id.getUpdates an outlet Tracking code to the site.putActivates Outlet tracking code.putDeactivates Outlet tracking code.putArchives Outlet tracking code.putRestores Outlet tracking code.putGets the Outlet code by Id.getAdds priced event assignments for a given Outlet Code.postUpdates the event assignments for a given Outlet Code.putRemoves an Event Assignment from an Outlet code.deleteBlacklists an event from the Outlet Code.postUpdates the existing Blacklisted Event's criteria.putRemoves a blacklisted event from the list.deleteLists an Outlet's Admins.getAdds an Outlet Admin if one isn't already added. Administrators should be globally unique within the system.postActivates a previously deactivated Outlet Admin.putDeactivates an Outlet Admin.putArchives an Outlet Admin.putRestores a previously archived Outlet Admin.putAdds an Outlet Admin if one isn't already added. Administrators should be globally unique within the system.putChanges role from Outlet admin to cashier or vice versa.putGets Outlets Statistics.getGets Statistics for an Outlet.getGets Outlets Graph.getGets Graph for an Outlet.getGets Outlets Orders.getGets Orders for an Outlet.getGets Outlets Report.getGets Report for an Outlet.getPaymentProcessorsV1Gets the Payment processor for the given Id.getDeletes the payment processordeleteGets the list of payment processorgetAdds Stripe Settings for payment processor.postAdds AuthNet Settings for payment processorpostAdds a Freeway Processor to the System.postAdds a Kicc Processor to the System.postUpdates the Freeway Processor Settings.putUpdate Stripe Settings.putUpdate Kicc Settings.putUpdates AuthNet setting.putArchives payment processorputRestores a previously archvied payment processorputEnables a given Payment Processor.putDisables a given Payment Processor.putRevokes Square access token.postRefreshes Square Access Token.postAdds a Square E-Commerce Processor to the system.postUpdates the Square E-Commerce Processor.putAdds a Latitude Technology Processor to the system.postUpdates Latitude Technology setting.putAdds a Asia Pay Processor to the system.postUpdates Asia Pay setting.putPlugsV1Gets a list of plugs.getGets a given plug by Slug Name.getGets a list of core plugs.getPremierV1Imports Premier Tickets in the system.postAdds a premier site into the system. If 'createCompany' is set to true, then Company Name and Domain information must be passed. If Company Admin and Password are passed, then a new company Admin with the provided credentials will be created.postPriceChangeRulesV1NEW/FINAL - Gets the Discount RulesgetNEW/FINAL - Adds sophisticated Discount rules for bulk purchases for tickets.postReturns a list of quantity based pricing rules for the event.getReturns a quantity based pricing rules for the event.getUpdate an existing quantity based pricing rule.putDelete an existing quantity based pricing rule.deleteAdd a new quantity based pricing rules to the event.postUpdate the archive status of an existing quantity based pricing rule.putUpdate the active status of an existing quantity based pricing rule.putProductCategoriesV1Deletes a Product Category if it isn't being used.deleteCreates a Product Category for a given company.postUpdates the Product CategoryputProductStoresV1Publishes/Activates a store.putAdds a Product to a Store.postRemoves a Product from a Store.deleteArchives a StoreputAssigns a Product Store to an Event.postGets the Product Stores.getAdds Company Product Store.postUnpublishes or deactivates a store.putRestores a store.putPromoCodesV1Adds multiple promo codes to a site based on the criteria provided.postGets the Promo Code Report for a given Date Range.getGets the Promo Code Report for a given Date Range.getGets the list of promo codes for Site.getAdds promo code for Site.postFilters the Promo Codes based on the criteria provided.postGets promo code for Site.getUpdates promo code for Site.putArchives the promo code for site.postRestores a given Promo code.postDeactivates the Promo code.postActivates the Promo code.postGets promo code group for Site.getUpdates promo code group for Site.putGets a list of promo codes for Site.getAdds promo code group for SitepostArchives the promo code group for Site.postBlacklists event from usage of promo code.postBlacklists ticket type from usage of promo code.postBlacklists ticket tier from usage of promo code.postAdds ticket type for the usage of promo code.postAdds ticket tier for the usage of promo code.postAdds event for the usage of promo code.postPublicV1Gets the event based on the event Id and Site Id.getGets event based on unique event url.getGets package event based on unique event url.getGets the list of events for the site.getReceiptsV1Gets receipt settings.getSaves receipt settings.postChanges logo of header in receipts.putRedisV1Flushes the Redis DB.deleteGets the Redis Entry for a specific key.postRemoves the Cached Event.deleteFlushes the Site Event datadeleteRemoves the Cached entry based on a given key.deleteReportsV1Gets the Event Ticket Sales for each day of the Event occurrence in the specified date range.postGets the Daily Sales Report.postGets the Event Manifest Report for a given event, date (or a range if passed) or seated section.postGets the Event's Sales Report by Categories assigned to Ticket Types and Tiers.getGets the Event's Sales Report by date.getGets the Event's Sales Report by tier.getGets the Event's Sales Report by tier.getGets the Geography Report. Valid Report Types are 'ByStateProvince', 'ByCountry', or 'ByZipCode'. If 'ByStateProvince' is chosen, then Country code must be passed. If 'excel' is passed or Accept-Type of "Accept : application/vnd.ms-excel" value is passed in Http Headers, will provide an ExcelpostGenerates the Inventory ReportpostGets the Reconciliation Report.postGets the Ticket Check-In Summary. If the event is a part of the season event, it will get the season event infomation as well.postGets the Tickets by Time slot report.postGets the Time Slot Summary.postGets the Transaction Summary for a given date (or a range if passed). All reports will be run from midnight to 11:59.59pm in the Site's local timezone.getGets the Sales by Sales Person report.postImports Events, GTOs, Outlets and Affiliates to data warehousepostImports Orders to data warehousepostGets the Country Geography Report. If 'excel' is passed or Accept-Type of "Accept : application/vnd.ms-excel" value is passed in Http Headers, will provide an ExcelpostGets the State Geography Report. Country code must be passed for state report. If 'excel' is passed or Accept-Type of "Accept : application/vnd.ms-excel" value is passed in Http Headers, will provide an ExcelpostGets the Zipcode Geography Report. Country code and state code must be passed for zipcode report. If 'excel' is passed or Accept-Type of "Accept : application/vnd.ms-excel" value is passed in Http Headers, will provide an ExcelpostGets the Event Manifest Report for a given event, date (or a range if passed) or seated section.postSalesReportsV1Gets the site sales overview.getGets the Ticket Sales Statistics for a given site.getGets Event Ticket Sales Statistics for a given site.getGets the daily site sales for the given date range.getGets the Event Sales Summary.getGets the Occurrence Stats for a given Event. If the Event is a non-recurring event, pass a null to obtain the Event's stats.postSalesRepsV1Lists the Sales Reps inside the system.getAssigns a Sales Rep to a given Site.postGets the Sales Reps for a given site.getLists the Sales Rep Sites.getScanningDevicesV1Add a Scanning DevicepostGets a Scanning Device by IdgetUpdates an existing Scanning DeviceputAssigns a Scanning Device to a VenueputActivate a scanning deviceputDeactivate a scanning deviceputArchive a Scanning DeviceputRestore an archived event offerputSeasonEventsV1Adds Parent Events to an Event.postRemoves an event from the parent list.deleteSeedDataV1Gets a list of timezones.getReturns a Timezone by Id.getGets a list of countries.getGets a list of countries.getGets the avaiable Locales for Internationalization.getGets the states for a given country.getGets the Payment Gateways that can be configured within the system.getGets the Charge Options.getGets the Credit Card Types that can be associated with the checkout.getGets available currencies within the system.getGets the Url types.getGets the Ticket Guardian selection criteria.getGets the Approval Types.getGets an enumeration of event fields to display when printing receipts.get/api/seeds/webhookpostGets the Shopping Cart Page Types.getGets the User Claim Types.getGets the various claims.getGets the Affiliate Payout Intervals.getGets the Scanning Device Types.getGets the Scanning Device Types.getGets list of FGL command seed data.getSettingsV1Gets the Policy settings.getSaves Policy settings for site.postGets Analytics settings.getSaves Analytics settings for the site.postGets Checkout settings.getSaves Checkout settings for the site.postGets the Ticket Guardian settings.getSaves the Ticket Guardian settings for the site.postGets a list of Checkout Widget SettingsgetSaves Checkout Widget settings for the site.postGets the Checkout Widget Settings By Id.getGets the Checkout Widget Settings By Id.putArchives a checkout Widget Setting.putRestores a previously archived checkout Widget Setting.putGets the eTicket Settings by Site Id.getSaves i.e. adds or updates the site eTicket Settings.postGets Smtp settings.getSaves Smtp settings for the site.postGets customer settings.getSaves Customer settings for the site.postGets customer settings.getSaves Customer settings for the company.postGets stripe connect settings for Company.getSaves Stripe Connect settings for the Company.postGets the Site Appearance Settings.getSaves the Site appearance Settings.postGets the Site Appearance Settings.getSaves the Ice Cream Social's Social Networking settings.postGets the site settings.getSaves site settings for the site.postGets the site settings.getSaves site settings for the site.postGets the Page Script Settings.getUpserts (adds or updates) a Page Script setting. If one exists, it will update, else will insert.postGets the Site Script settings.getDeletes site setting based on setting Id.deleteDeletes company setting based on setting Id.deleteSynchronizes the settings into a read-only setting. Admin only calls.postGets all of the site settings in a single call.get/api/sites/{siteId}/specific-settingsgetGets currency conversion setting for a Site.getAdds new currency conversion setting.postGet currency conversion Setting By Id.getUpdates currency conversion Setting.putDeletes currency conversion Setting.deleteShippingMethodsV1Gets list of Shipping Method.getAdds Shipping Method.postGets Shipping Method By Id.getUpdates Shipping Method.putArchives Shipping Method.putRestores Shipping Method.putSet Default Shipping Method.putAdds Tiered Price.postDelete Tiered Price.deleteGets list of Event Shipping Method.getAdds Event Shipping Method.postGets Event Shipping Method By Id.getUpdates Event Shipping Method.putDelete Event Shipping Method.deleteMigrates the existing Sql Shipping Method to the new Mongo.postMigrates the existing Sql Event Shipping Method to the new Mongo.postShippingV1Gets the Flat Rate Shipping items.getAdds a Flat Rate Shipping Criteria to the site.postGets Flat Rate Shipping criteria by id.getUpdates a Flat Rate Shipping Criteria.putArchives a Flat Rate Shipping.putRestores a previously archived Flat Rate Shipping.putGets the Flat Rate Shipping Costs by Flat Rate Shipping id.getAdds a Flat Rate Shipping Cost.postUpdates the Flat Rate Shipping Cost.putShoppingCartV1Initializes a new shopping cart instance for the User. If a cart already exists, appropriate error message is shown. Only Administrators will be able to create an order in the Box Office mode.postGets the shopping cart based on cart Id.getAbandons the cart.deleteLinks a User's account with a cart.postAdds the Shipping information required for the checkout process.postAdds the Billing Information for the Cart.postSigns the Waivers needed for the Ticket purchase.postValidates the cart by verifying all the required conditions are met.postInitiates the Checkout process by checking out the user's shopping cart.postInitiates the Checkout process for a kicc checkout by checking out the user's shopping cart.postInitiates the Checkout process for a square readerSDK device by checking out the user's shopping cart.postApplies the installment plan to the cart.postGets the Installment Plan and their Payment Summary for the cart.getAdds tickets to cart. Can add multiple tiers to cart.postGets the tickets associated with a given Cart Line Item.getRedeems a given Promo Code.postRemoves all instances of the used Promo Code from cart.deleteRemoves a ticket from the cart.deleteUpdates the quantity of tickets for the given line Item. If the new quantity is greater than the old quantity, new tickets are added. If new quantity is less than old quantity, tickets are removed if and only if they are empty. If Attendee info exists for any tickets, it will not let you update the quantity.postRemoves a Line Item from the Cart.deleteFINAL: Updates the Attendee Information.putRemoves a given Attendee from a given Ticket.deleteAdds attendee info if one doesn't exist. Updates it if it is already available.patchFINAL - Saves answer information of the event questions for Attendee.putInserts or updates the purchaser details.postSaves answer information of the event questions for Purchasers.putGets the Purchaser Questions associated with a given Cart.getSaves the Purchaser Answers associated with a given Cart.postGets the Shipping Methods for each tier in the cart.getSaves the Order Shipping Methods and calculates the Shipping Costs.postGets one or more Cart Offers.getGets the Cart's Payment Options.get/api/public/sites/{siteId}/shopping-carts/{cartId}/mobile-authorizationpostSiteProductAttributesV1Gets the site's product attributesgetAdds a Product Attribute with its options.postSiteProductsV1Adds a Site Product.postGets a Site Product by Id.getUpdates the Product based on product id.putAssigns a Shipping Class to a given Product.postAdds a Variant Product to the system.postAdds a product variation.postArchives a Product. If the product has variants, then it will archive the variants as well.putRestores a given product. If the product has variants, it will not restore the variants. Each variant needs to be individually restored.putGets site products.getAdds a Product Photo.postDeletes a product photo.deleteSets a Primary Photo.putAssign product attribute options.postSiteShippingClassesV1Gets the Shipping Classes configured for a given site.getAdds a Shipping class.postGets the Shipping Class by Code.getUpdates the Shipping Class by code.putActivate a Shipping Class.putDeactivates a Shipping Class.putArchives a Shipping Class.putRestores a previously archived Shipping Class.putSitesV1Gets the sites managed by a given user.getGets the site information by abbreviation.getGets the Site information by Id.getGets the Sites configured for a given company.getAdds a Site for a given Company.postGets the Site information.getUpdates the Site information.putPublishes the Site.putUn-publishes the Site.putActivates the Site.putDe-activates the Site.putRestores a Site.putNew: Gets Site administrators, optionally based on one or more roles.getAllows system administrator to add Site Administrator.postLinks an existing Administrator to the current site.postGets the Site Admin if the calling user has the necessary permissions.getUpdates the User info.putAllows an administrator or super admin to change password of its members.postAllows system administrator to Deactivate Site administrator.putAllows system administrator to Activate Site administrator.putAllows system administrator to Archive Site administrator.putAllows system administrator to Restore Site administrator.putGets the Site Plugs by Site Id.getInstalls plug for the given Site Id.postActivates the Plug for the Site Id.putChecks whether a given Site plug is installed or not.getDeactivates the Plug for the Site Id.putUninstalls plug for the given Site Id.postGets site logo.get/api/sites/{siteId}/logopostDeletes site logo.deleteUpdate the Tenant Profile.putEnables PII Encryption for a site.postDisables PII Encryption for a site.postStoreV1/api/sites/{siteId}/storesget/api/sites/{siteId}/storespost/api/sites/{siteId}/stores/{storeId}get/api/sites/{siteId}/stores/{storeId}putStripeConnectV1Gets the Redirect URL to use for a given site. This URL needs to be added to the Primary Account Holder's Stripe Connect Redirect URL list.getGets the Stripe Connect button URL for the given Site for Development mode.getGets the Stripe Connect button URL for the given Site for Live mode.getProcesses the Stripe Connect Response.postGets Stripe connect split settings for company.getAdds stripe connect split setting for company.postGets stripe connect split settings.getUpdates stripe connect split setting.putRemoves stripe connect split settings.deleteGets split item.getUpdates split item.putDeletes a split item from the Stripe Split Settings.deleteGets stripe connect settings for Company.getSaves Stripe Connect settings for the Company.postAdds Stripe Connect Settings for the Secondary Payment processor.postUpdates the settings of the Secondary Stripe Connect Processor.putUpdates development settings for stripe connect processor.putUpdates live settings for stripe connect processor.putGets the stripe connect payment processorsgetTemplatingV1GEts the Template groups and the field.sgetAdds a new Template Group to the system.postAdds a Template field to a template group.post/api/templating/groups/{groupId}getTicketCategoriesV1Gets one or more Ticket Categories.getAdds a Ticket Category.postGets the Ticket Category by Id.getAdds a Tier Category.postAdds a Ticket Type Category.postTicketPurchaseRulesV1Adds a Standard Ticket Purchase Rule targeting one or more events for a given Site.postAdds a sub-group to a Standard Purchase Rule.postTicketsV1Gets a list of Events for a ticket.getGets a Ticket by Id.getRedeems the ticket by bar code.postDeletes the Ticket Redemption and marks the Ticket as active.postTicketTypesV1Gets a ticket Type for the given idgetGets ticket types for a given Event.getAdds a Ticket Type for a given Event.postReorders the Ticket Types in the order of ids passed.postReorders the Ticket Tiers in the order of ids passed.postUpdates the Ticket Type information.putClones a given Ticket Type.postClones the tier.postMoves a ticket tier from one to another.postGets the pricing tiers based on the ticket type Id.getAdds pricing tiers to a given ticket typepostGets Pricing Tier based on the Ticket Tier Id.getUpdates the pricing tier information for a given Ticket TypeputAdds custom data to an existing tier.postUpdates the tier's custom data element.putDeletes the tier's custom data element.deleteMarks a given Tier as featured.putRemoves a given Tier's featured status.deleteGet publishing options for the ticket type.getSets a ticket type on sale.putRemoves the on-sale status of the ticket type and its tiersdeleteSet publish status of simple ticket type.putUnpublishes the ticket type and all its tiers.deleteHides the ticket type from list status. This is used for Private Ticket Types that are available for internal use only. This allows setting a ticket on sale but hiding it from the public view.putShows the ticket type from list status.putGets pricing tier publishing options.getSets pricing tier on sale.putRemoves on-sale status of the pricing tier.deleteShows pricing tier from the list status.putHides pricing tier from the list status.deletePublishes pricing tier.putUnpublishes pricing tier.deleteBlocks promo code for ticket type.putAllows promo code for ticket type.putGets the description settings for a ticket type.getSaves/Updates the descriptions for ticket type.putGets description information for the pricing tier.getSaves the descriptions for pricing tiers.putArchives ticket type.putRestores a ticket type.putArchives pricing tier.putRestores pricing tier.putTierTypeV1Gets Tier Types.getAdds Tier Type.postGets Tier Type based on the Id.getUpdates Tier Type.putUserOrdersV1Gets the User's Orders.getCancels the Order.postGets a User's Events.getTransfers an Order's tickets.postUsersV1Upserts the User's billing info. If 'self' is passed, will upsert the logged in user's billing info. If the User Id is passed, will update the user's billing info if and only if the user has permissions to update the User's billing info.postGets the User's info by the User Id. If 'self' is passed, will get the logged in User's Id. Else will get the User's info provided the user requesting has access to the target user's info.getUpdate's the User's Account information.putGets the User's info based on the domain. If no domain is passed, a root admin is assumed and will be looked up.getGets the Companies a user can manage.get/api/users/sitesgetGets a User's sites.getArchives a user.putRestores a previously archived user.putActivates a given user.putDeactivates a given user.putGets the logged in User's information.getVenuesV1Gets list of venues for the SiteIdgetAdds a venue to the system.postClones a venue by copying Name, Configuration, Address.postGets the Venue for the specified Id.getUpdates the venue.putDeletes a venue for a given site.deleteArchives a given venue.putUploads the Section's SVG.postRestores a given venue.putAssigns the Seated Venue to a given site.postGets a list of the Venue Sections.getAdds a section to Venue.postGets a Venue's Section.getUpdates the Section for a given Venue.putDeletes the Section from a venue.deleteClones a section by copying Title, Key, Rows, Seats.postUploads the Section's SVG.postAdds or Updates the Section Seating Info. If a Row already exists for a new one being added, the new information will overwrite this info.postSets the Row Order.postAdds seat to a specified section/row.postDeletes a Row from the specified Section.deleteAdds or Updates a Row's seating information.postDeletes seat from a row.deleteSets the Seat Order.postAdds a Seat as an Accessible Seat for a given section.post/api/sites/{siteId}/venues/{venueId}/sections/{sectionKey}/rows/{rowKey}/seats/{seatKey}/accessible-seatingdeleteGets Venue Levels.getAdds a Venue level to a given Venue.postUpdates a Venue level to a given Venue.putDeletes a Venue level to a given Venue.deleteUploads image for an Event.postUploads image for an Event.deleteWaiversV1Gets a list of Waivers.getAdds a new Waiver.postGets a Waiver for the given Id.getUpdate Waiver.putDelete Waiver.deleteGet All EventWaivers for an EventgetAssign waivers to eventspostRemoves waiver assigned to EventdeletePowered by Allows system administrator to add Site Administrator.post https://example.com/api/sites/{siteId}/administrators
