README
¶
tm-go - Go API library for Ticketmatic
This library provides Go bindings for the Ticketmatic API.
You'll need to enroll in the Ticketmatic Developer Program to obtain a set of API keys.
More info & contact details: https://www.ticketmatic.com/
Documentation
¶
Overview ¶
The Ticketmatic API can be found in the ticketmatic package.
Documentation: https://godoc.org/github.com/ticketmatic/tm-go/ticketmatic
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
The Ticketmatic API is a REST (http://en.wikipedia.org/wiki/Representational_state_transfer) API.
|
The Ticketmatic API is a REST (http://en.wikipedia.org/wiki/Representational_state_transfer) API. |
|
contacts
Contact manipulation operations Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/contacts).
|
Contact manipulation operations Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/contacts). |
|
diagnostics
Diagnostic API calls to help while debugging.
|
Diagnostic API calls to help while debugging. |
|
events
Before using events through the API, be sure to read the event setup guide (https://www.ticketmatic.com/docs/events/events).
|
Before using events through the API, be sure to read the event setup guide (https://www.ticketmatic.com/docs/events/events). |
|
jobs
API calls for jobs.
|
API calls for jobs. |
|
orders
Orders are one of the main concepts in Ticketmatic.
|
Orders are one of the main concepts in Ticketmatic. |
|
ratelimiting
Each account has a built-in rate limiter and may optionally use queues to streamline the handling of peak sales.
|
Each account has a built-in rate limiter and may optionally use queues to streamline the handling of peak sales. |
|
sales/waitinglistrequests
Waiting list requests are used to show interest in events when tickets aren't available.
|
Waiting list requests are used to show interest in events when tickets aren't available. |
|
settings/accountparameters
Account parameters control central parameters related to your account.
|
Account parameters control central parameters related to your account. |
|
settings/communicationanddesign/documents
Ticketmatic allows you to create documents for contacts and orders, you can read more in this article (https://www.ticketmatic.com/docs/setup/document) Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/documents).
|
Ticketmatic allows you to create documents for contacts and orders, you can read more in this article (https://www.ticketmatic.com/docs/setup/document) Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/documents). |
|
settings/communicationanddesign/ordermails
Order mail templates are used to construct e-mails sent to customers.
|
Order mail templates are used to construct e-mails sent to customers. |
|
settings/communicationanddesign/ticketlayouts
Ticket layouts define the list of layouts that can be used for tickets.
|
Ticket layouts define the list of layouts that can be used for tickets. |
|
settings/communicationanddesign/ticketlayouttemplates
Ticket layout templates define a specific template (with a specific size) for a layout.
|
Ticket layout templates define a specific template (with a specific size) for a layout. |
|
settings/communicationanddesign/webskins
Web sales skins define skins for the web sales interface.
|
Web sales skins define skins for the web sales interface. |
|
settings/events/eventlocations
Events can be linked to an event location, which consists of a name and an address.
|
Events can be linked to an event location, which consists of a name and an address. |
|
settings/pricing/orderfeedefinitions
Order fee definitions Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/pricing/orderfeedefinitions).
|
Order fee definitions Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/pricing/orderfeedefinitions). |
|
settings/pricing/pricelists
Price lists are used to define the actual prices that will be available for one or more events.
|
Price lists are used to define the actual prices that will be available for one or more events. |
|
settings/pricing/pricetypes
Pricetypes describe the different types of prices that exist for an event and are used in pricelists to define actual prices.
|
Pricetypes describe the different types of prices that exist for an event and are used in pricelists to define actual prices. |
|
settings/pricing/ticketfees
Ticket fees are schemes that define what fee will be added to the ticket price, depending on the price type and the sales channel used when the ticket is sold.
|
Ticket fees are schemes that define what fee will be added to the ticket price, depending on the price type and the sales channel used when the ticket is sold. |
|
settings/productcategories
Each product belongs to a product category.
|
Each product belongs to a product category. |
|
settings/products
Product types There are 4 product types: * Simple (26001) * Voucher (26002) * Fixed bundle (26003) * Option bundle (26004) You can find more information about these types here (https://www.ticketmatic.com/docs/events/products).
|
Product types There are 4 product types: * Simple (26001) * Voucher (26002) * Fixed bundle (26003) * Option bundle (26004) You can find more information about these types here (https://www.ticketmatic.com/docs/events/products). |
|
settings/seatingplans/seatingplans
A seating plan describes the structural layout of an event location and allows for buying tickets for numbered seats.
|
A seating plan describes the structural layout of an event location and allows for buying tickets for numbered seats. |
|
settings/seatingplans/seatranks
Seat ranks Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/seatingplans/seatranks).
|
Seat ranks Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/seatingplans/seatranks). |
|
settings/system/contactaddresstypes
Address types allow you to attach a type to different addresses.
|
Address types allow you to attach a type to different addresses. |
|
settings/system/contactfields
The contact fields list all fields that are asked when a contact is created.
|
The contact fields list all fields that are asked when a contact is created. |
|
settings/system/contacttitles
Contact titles are used to define different titles for contacts.
|
Contact titles are used to define different titles for contacts. |
|
settings/system/customfields
Custom fields allow you to extend the Ticketmatic data model with your own data fields.
|
Custom fields allow you to extend the Ticketmatic data model with your own data fields. |
|
settings/system/customfieldvalues
Custom field values are used for specific types of custom fields (single select, multi select).
|
Custom field values are used for specific types of custom fields (single select, multi select). |
|
settings/system/dupedetectrules
Dupe detect rules are used for contact deduplication.
|
Dupe detect rules are used for contact deduplication. |
|
settings/system/fielddefinitions
Field definition types There are 5 different field definition types: * Order (10001) * Contact (10002) * Event (10003) * Ticket (10004) * Payment (10005) Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/system/fielddefinitions).
|
Field definition types There are 5 different field definition types: * Order (10001) * Contact (10002) * Event (10003) * Ticket (10004) * Payment (10005) Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/system/fielddefinitions). |
|
settings/system/filterdefinitions
Filter definitions define filters that can be used in the backoffice.
|
Filter definitions define filters that can be used in the backoffice. |
|
settings/system/optins
Define a set of opt ins for your customers regarding .
|
Define a set of opt ins for your customers regarding . |
|
settings/system/phonenumbertypes
Phone number types allow you to attach a type to different phone numbers.
|
Phone number types allow you to attach a type to different phone numbers. |
|
settings/system/relationtypes
Relation types can be used to introduce a hierarchy of contacts.
|
Relation types can be used to introduce a hierarchy of contacts. |
|
settings/system/reports
Report types There are 7 different report types: * Simple (1) * Event (3) * Time Period (5) * Period User (9) * Multi Event (10) * Period and Multi Event (11) * 2 Period (12) * Date with Time Period (13) * Time Period User (14) Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/system/reports).
|
Report types There are 7 different report types: * Simple (1) * Event (3) * Time Period (5) * Period User (9) * Multi Event (10) * Period and Multi Event (11) * 2 Period (12) * Date with Time Period (13) * Time Period User (14) Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/system/reports). |
|
settings/system/ticketsalesflows
Ticket sales flows Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/system/ticketsalesflows).
|
Ticket sales flows Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/system/ticketsalesflows). |
|
settings/system/ticketsalessetups
Ticket sales setup Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/system/ticketsalessetups).
|
Ticket sales setup Help Center Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/settings/system/ticketsalessetups). |
|
settings/system/views
Use views to provide customer information about the main entities in the Ticketmatic applications.
|
Use views to provide customer information about the main entities in the Ticketmatic applications. |
|
settings/ticketsales/deliveryscenarios
A delivery scenario defines how an order will be delivered.
|
A delivery scenario defines how an order will be delivered. |
|
settings/ticketsales/locktypes
When configuring an event, it is possible to reserve some tickets or make them unavailable.
|
When configuring an event, it is possible to reserve some tickets or make them unavailable. |
|
settings/ticketsales/orderfees
Order fees determine which extra costs or discounts can be added to an order.
|
Order fees determine which extra costs or discounts can be added to an order. |
|
settings/ticketsales/paymentmethods
A payment method defines the method of an actual payment.
|
A payment method defines the method of an actual payment. |
|
settings/ticketsales/paymentscenarios
A payment scenario defines how a customer will pay for an order.
|
A payment scenario defines how a customer will pay for an order. |
|
settings/ticketsales/saleschannels
In Ticketmatic, each order is created in the context of a sales channel (https://www.ticketmatic.com/docs/tickets/configure_ticket_sales/saleschannels).
|
In Ticketmatic, each order is created in the context of a sales channel (https://www.ticketmatic.com/docs/tickets/configure_ticket_sales/saleschannels). |
|
settings/vouchers
Voucher types There are 2 voucher types: * Pricetype (24001) * Payment (24003) You can find more information about vouchers here (https://www.ticketmatic.com/docs/events/vouchers).
|
Voucher types There are 2 voucher types: * Pricetype (24001) * Payment (24003) You can find more information about vouchers here (https://www.ticketmatic.com/docs/events/vouchers). |
|
subscribers
Subscribers are Contacts that are subscribed for e-mail marketing actions.
|
Subscribers are Contacts that are subscribed for e-mail marketing actions. |
|
tools
Miscellaneous tools for retrieving information from the account.
|
Miscellaneous tools for retrieving information from the account. |
Click to show internal directories.
Click to hide internal directories.