Documentation
¶
Overview ¶
The Ticketmatic API is a REST (http://en.wikipedia.org/wiki/Representational_state_transfer) API. The API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors.
You can make requests to Ticketmatic API from a terminal or browser, or from within any code. The examples in the documentation use curl, but you can use wget, libcurl or any other method to GET and POST in your preferred language. Your preferred coding language should include libraries to support making HTTP requests and parsing responses.
---
URI ¶
The URIs for endpoints are served at ¶
https://apps.ticketmatic.com/api/1/{accountname}/
Note that Ticketmatic API is secure, so use HTTPS whenever you access any endpoints. Calls made over plain HTTP will fail.
---
Libraries ¶
The recommended way to integrate with the Ticketmatic API is to use a library. The following languages are currently supported:
* PHP (https://www.ticketmatic.com/docs/api/libraries/php)
If you're preferred language is not on this list, please let us know (mailto:[email protected])
---
Getting started ¶
Be sure to read up on the core concepts first:
* Authentication (https://www.ticketmatic.com/docs/api/coreconcepts/authentication)
* Error handling (https://www.ticketmatic.com/docs/api/coreconcepts/errors)
* Translations (https://www.ticketmatic.com/docs/api/coreconcepts/translations)
* Custom fields (https://www.ticketmatic.com/docs/api/coreconcepts/customfields)
Afterwards, check the pages of the individual endpoints you wish to use.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/).
Index ¶
- Constants
- Variables
- func MustParseTime(s string) time.Time
- func ParseTime(s string) (time.Time, error)
- func Sign(accesskey, secretkey, accountcode, ts string) string
- type AccountInfo
- type AccountParameter
- type AddItemsResult
- type AddPayments
- type AddProducts
- type AddRefunds
- type AddTickets
- type AddVoucherCodes
- type Address
- type Appoptin
- type BatchContactOperation
- type BatchContactParameters
- type BatchContactUpdateField
- type BatchEventOperation
- type BatchEventParameters
- type BatchEventUpdateField
- type BatchOrderOperation
- type BatchOrderParameters
- type BatchOrderUpdateField
- type BatchResult
- type BatchResultItem
- type Client
- type Contact
- type ContactAddressType
- type ContactAddressTypeQuery
- type ContactBatchUpdate
- type ContactField
- type ContactGetQuery
- type ContactIdReservation
- type ContactImportStatus
- type ContactOptIn
- type ContactOptInInfo
- type ContactQuery
- type ContactRelationship
- type ContactRemark
- type ContactTitle
- type ContactTitleQuery
- type CreateOrder
- type CreateProduct
- type CreateTicket
- type CustomField
- type CustomFieldQuery
- type CustomFieldValue
- type CustomFieldValueQuery
- type CustomfieldAvailability
- type DeleteProducts
- type DeleteTickets
- type DeliveryScenario
- type DeliveryScenarioQuery
- type DeliveryscenarioAvailability
- type Document
- type DocumentOptions
- type DocumentQuery
- type DupeDetectCriteria
- type DupeDetectRule
- type DupeDetectRuleQuery
- type Event
- type EventContext
- type EventContingent
- type EventContingentAvailability
- type EventContingentLock
- type EventFilter
- type EventLocation
- type EventLocationQuery
- type EventLockTickets
- type EventPreview
- type EventPrices
- type EventPricesContingent
- type EventPricesCost
- type EventPricesPricetype
- type EventPricesSaleschannel
- type EventQuery
- type EventSalesChannel
- type EventScanTicketsOut
- type EventSeatingplanContingent
- type EventTicket
- type EventTicketFilter
- type EventTicketQuery
- type EventUnlockTickets
- type EventUpdateSeatRankForTickets
- type EventUpsellitem
- type EventstreamItem
- type EventstreamRequest
- type EventstreamResult
- type FieldDefinition
- type FieldDefinitionQuery
- type FielddefinitionsDataRequest
- type FielddefinitionsDataResult
- type FilterDefinition
- type FilterDefinitionQuery
- type FilterItem
- type Flowinfo
- type Flowsession
- type ImportBundleTicket
- type ImportOrder
- type ImportOrdercost
- type ImportPayment
- type ImportProduct
- type ImportTicket
- type JobResult
- type KeyValueItem
- type Layout
- type LockTemplate
- type LockType
- type LockTypeQuery
- type LogItem
- type LogicalPlan
- type LogicalPlanRow
- type LogicalPlanSeat
- type OptIn
- type OptInAvailability
- type OptInQuery
- type Order
- type OrderFee
- type OrderFeeDefinition
- type OrderFeeDefinitionQuery
- type OrderFeeQuery
- type OrderFilter
- type OrderIdReservation
- type OrderImportStatus
- type OrderMailTemplate
- type OrderMailTemplateQuery
- type OrderProduct
- type OrderQuery
- type OrderTicket
- type OrderTickettype
- type Ordercost
- type OrderfeeAutoRule
- type OrderfeeRule
- type OrderfeeScriptContext
- type Payment
- type PaymentMethod
- type PaymentMethodQuery
- type PaymentRequest
- type PaymentScenario
- type PaymentScenarioQuery
- type PaymentscenarioAvailability
- type PaymentscenarioExpiryParameters
- type PaymentscenarioOverdueParameters
- type PhoneNumberType
- type PhoneNumberTypeQuery
- type Phonenumber
- type PriceList
- type PriceListQuery
- type PriceType
- type PriceTypeQuery
- type PricelistPrice
- type PricelistPriceCondition
- type PricelistPrices
- type Product
- type ProductCategory
- type ProductCategoryQuery
- type ProductInstanceException
- type ProductInstancePricetypeValue
- type ProductInstanceValue
- type ProductInstancevalues
- type ProductProperty
- type ProductQuery
- type ProductVoucherValue
- type PurgeOrdersRequest
- type QueryRequest
- type QueryResult
- type RateLimitError
- type RelationType
- type RelationTypeQuery
- type Report
- type ReportOptions
- type ReportQuery
- type Request
- type RequestError
- type SalesChannel
- type SalesChannelQuery
- type SeatDescriptionTemplate
- type SeatRank
- type SeatRankQuery
- type SeatingPlan
- type SeatingPlanQuery
- type ServicemailScheduling
- type SetOrderCost
- type SplitOrder
- type Stream
- type SubscriberCommunication
- type SubscriberSync
- type TicketFee
- type TicketFeeQuery
- type TicketLayout
- type TicketLayoutQuery
- type TicketLayoutTemplate
- type TicketLayoutTemplateQuery
- type TicketfeeException
- type TicketfeeRules
- type TicketfeeSaleschannelRule
- type TicketsEmaildeliveryRequest
- type TicketsPdfRequest
- type TicketsalesFlowConfig
- type Ticketsalesflow
- type TicketsalesflowQuery
- type Ticketsalessetup
- type TicketsalessetupQuery
- type TicketsprocessedRequest
- type TicketsprocessedStatistics
- type Time
- type Timestamp
- type UpdateOrder
- type UpdateProducts
- type UpdateTickets
- type Url
- type View
- type ViewColumn
- type ViewQuery
- type Voucher
- type VoucherCode
- type VoucherQuery
- type VoucherValidity
- type WaitingListRequest
- type WaitingListRequestItem
- type WaitingListRequestItemTicket
- type WaitingListRequestQuery
- type WebSalesSkin
- type WebSalesSkinConfiguration
- type WebSalesSkinQuery
- type Widgets
Constants ¶
const Build = "1.0.118"
Library Version
Variables ¶
var Server = "https://apps.ticketmatic.com"
API server to use.
var Version = "1"
API version
Functions ¶
Types ¶
type AccountInfo ¶ added in v1.0.43
type AccountInfo struct {
// Account ID
Id int64 `json:"id"`
// Account Name
Name string `json:"name"`
// Account address
Address string `json:"address"`
// Link to the account image
Image string `json:"image"`
// Latitude
Lat float64 `json:"lat"`
// Link to the account logo
Logo string `json:"logo"`
// Longitude
Long float64 `json:"long"`
// Account short name
Shortname string `json:"shortname"`
// Account website
Url string `json:"url"`
}
Account information
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/AccountInfo).
type AccountParameter ¶
type AccountParameter struct {
// The name of the account parameter
Key string `json:"key"`
// Value
Value interface{} `json:"value,omitempty"`
}
An account parameter defines general behavior of your account
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/AccountParameter).
type AddItemsResult ¶
type AddItemsResult struct {
// Ids of the items that were added
Ids []int64 `json:"ids"`
// The modified order
Order *Order `json:"order,omitempty"`
}
Result when adding tickets (https://www.ticketmatic.com/docs/api/orders/addtickets) or products (https://www.ticketmatic.com/docs/api/orders/addproducts) to an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/AddItemsResult).
type AddPayments ¶
type AddPayments struct {
// Amount for the payment
Amount float64 `json:"amount"`
// Id of the payment method to be used for the payment
Paymentmethodid int64 `json:"paymentmethodid"`
// Voucher code to use for this payment
Vouchercode string `json:"vouchercode,omitempty"`
// Voucher code id to use for this payment
Vouchercodeid int64 `json:"vouchercodeid,omitempty"`
}
Request data used to add a payment (https://www.ticketmatic.com/docs/api/orders/addpayments) to an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/AddPayments).
type AddProducts ¶
type AddProducts struct {
// Product information
Products []*CreateProduct `json:"products"`
}
Request data used to add products (https://www.ticketmatic.com/docs/api/orders/addproducts) to an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/AddProducts).
type AddRefunds ¶
type AddRefunds struct {
// Amount that needs to be refunded
Amount float64 `json:"amount"`
// Id of the payment that needs to be refunded
Paymentid int64 `json:"paymentid"`
}
Request data used to refund a payment (https://www.ticketmatic.com/docs/api/orders/addrefunds) for an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/AddRefunds).
type AddTickets ¶
type AddTickets struct {
// If this is set adding the tickets will only succeed if all tickets can be placed
// on a single row
Onlysinglerow bool `json:"onlysinglerow,omitempty"`
// Ticket information
Tickets []*CreateTicket `json:"tickets"`
}
Request data used to add tickets (https://www.ticketmatic.com/docs/api/orders/addtickets) to an order (https://www.ticketmatic.com/docs/api/types/Order). The amount of tickets that can be added is limited to 50 per call.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/AddTickets).
type AddVoucherCodes ¶
type AddVoucherCodes struct {
// Value of the voucher
Amount float64 `json:"amount,omitempty"`
// List of voucher codes, can also (optionally) contain expiry timestamps.
Codes []*VoucherCode `json:"codes"`
// Number of codes to create
Count int64 `json:"count"`
// Whether or not to reactivate and update the expiry of already existing
// vouchercodes.
Update bool `json:"update,omitempty"`
}
Parameters used to create voucher codes
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/AddVoucherCodes).
type Address ¶
type Address struct {
// Address ID
//
// Note: Only available when used for a contact
// (https://www.ticketmatic.com/docs/api/types/Contact) address.
Id int64 `json:"id"`
// Address type ID
//
// Note: Only available when used for a contact
// (https://www.ticketmatic.com/docs/api/types/Contact) address.
Typeid int64 `json:"typeid"`
// Addressee
//
// Note: Only available when used as an order
// (https://www.ticketmatic.com/docs/api/types/Order) deliver address.
Addressee string `json:"addressee"`
// City
City string `json:"city"`
// Country name (based on typeid, returned as a convenience).
//
// Note: Only available when used for a contact
// (https://www.ticketmatic.com/docs/api/types/Contact) address.
Country string `json:"country"`
// ISO 3166-1 alpha-2 country code
// (http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
Countrycode string `json:"countrycode"`
// Contact this address belongs to
//
// Note: Only available when used for a contact
// (https://www.ticketmatic.com/docs/api/types/Contact) address.
Customerid int64 `json:"customerid"`
// State
State string `json:"state"`
// Street field 1 (typically the street name)
Street1 string `json:"street1"`
// Street field 2 (typically the number)
Street2 string `json:"street2"`
// Street field 3 (sometimes used for box numbers or suffixes)
Street3 string `json:"street3"`
// Address type (based on typeid, returned as a convenience).
//
// Note: Only available when used for a contact
// (https://www.ticketmatic.com/docs/api/types/Contact) address.
Type string `json:"type"`
// Zip code
Zip string `json:"zip"`
}
Address, used for physical deliveries and contact details.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Address).
type Appoptin ¶ added in v1.0.118
type Appoptin struct {
// IP address
Ip string `json:"ip"`
// The message shown for the optin
Message string `json:"message"`
// Method used for optin
Method string `json:"method"`
// The status of the optin
Status bool `json:"status"`
// Created timestamp
Ts string `json:"ts"`
}
App optin
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Appoptin).
type BatchContactOperation ¶
type BatchContactOperation struct {
// Restrict operation to supplied IDs, if these ids are not specified all contacts
// are updated.
Ids []int64 `json:"ids"`
// Operation to perform, possible values are: addrelationtypes ,
// removerelationtypes, delete, subscribe, unsubscribe and update
Operation string `json:"operation"`
// Operation-specific parameters
Parameters *BatchContactParameters `json:"parameters,omitempty"`
}
Batch operations performed on contacts
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/BatchContactOperation).
type BatchContactParameters ¶
type BatchContactParameters struct {
// Selection name, used for operation sendselection
Name string `json:"name,omitempty"`
// [DEPRECATED] Use updatefields instead
Fields *ContactBatchUpdate `json:"fields,omitempty"`
// Relation type IDs, used for operations addrelationtypes and removerelationtypes
Ids []int64 `json:"ids"`
// Primary contact to merge into
Primary int64 `json:"primary,omitempty"`
// Set of fields to update, used for operation update. Custom fields are also
// supported.
Updatefields []*BatchContactUpdateField `json:"updatefields"`
}
Parameters for batch operations performed on contacts
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/BatchContactParameters).
type BatchContactUpdateField ¶ added in v1.0.107
type BatchContactUpdateField struct {
// The name of the field, can either be a custom field or one of the following
// fixed fields (customertitleid, languagecode).
Key string `json:"key"`
// The type of update that needs to be done on the field. Can either be set
// (default), add or remove when used in combination with multi value fields.
Updatetype string `json:"updatetype"`
// The value of the field
Value interface{} `json:"value,omitempty"`
}
Field to update on contact
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/BatchContactUpdateField).
type BatchEventOperation ¶ added in v1.0.107
type BatchEventOperation struct {
// Restrict operation to supplied IDs, if these ids are not specified all events
// are updated.
Ids []int64 `json:"ids"`
// Operation to perform, possible values are: duplicate , publish, delete, close,
// update, redraft, reopen
Operation string `json:"operation"`
// Operation-specific parameters
Parameters *BatchEventParameters `json:"parameters,omitempty"`
}
Batch operations performed on events
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/BatchEventOperation).
type BatchEventParameters ¶ added in v1.0.107
type BatchEventParameters struct {
// Set of fields to update, used for operation update. Custom fields are also
// supported.
Updatefields []*BatchEventUpdateField `json:"updatefields"`
}
Parameters for batch operations performed on events
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/BatchEventParameters).
type BatchEventUpdateField ¶ added in v1.0.107
type BatchEventUpdateField struct {
// The name of the field, can either be a custom field or one of the following
// fixed fields (name, subtitle, webremark, startts, endts, locationid,
// ticketlayoutid, seatselection).
Key string `json:"key"`
// The type of update that needs to be done on the field. Can either be set
// (default), add or remove when used in combination with multi value fields.
Updatetype string `json:"updatetype"`
// The value of the field
Value interface{} `json:"value,omitempty"`
}
Field to update on event
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/BatchEventUpdateField).
type BatchOrderOperation ¶ added in v1.0.108
type BatchOrderOperation struct {
// Restrict operation to supplied IDs, if these ids are not specified all events
// are updated.
Ids []int64 `json:"ids"`
// Operation to perform, possible values are: emaildelivery , update, pdf
Operation string `json:"operation"`
// Operation-specific parameters
Parameters *BatchOrderParameters `json:"parameters,omitempty"`
}
Batch operations performed on orders
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/BatchOrderOperation).
type BatchOrderParameters ¶ added in v1.0.108
type BatchOrderParameters struct {
// Set of fields to update, used for operation update. Custom fields are also
// supported.
Updatefields []*BatchOrderUpdateField `json:"updatefields"`
}
Parameters for batch operations performed on orders
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/BatchOrderParameters).
type BatchOrderUpdateField ¶ added in v1.0.108
type BatchOrderUpdateField struct {
// The name of the field, can either be a custom field or one of the following
// fixed fields (deliveryscenarioid, paymentscenarioid).
Key string `json:"key"`
// The type of update that needs to be done on the field. Can either be set
// (default), add or remove when used in combination with multi value fields.
Updatetype string `json:"updatetype"`
// The value of the field
Value interface{} `json:"value,omitempty"`
}
Field to update on order
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/BatchOrderUpdateField).
type BatchResult ¶ added in v1.0.103
type BatchResult struct {
// The number of items for which the batch operation succeeded.
Nbrsucceeded int64 `json:"nbrsucceeded,omitempty"`
// Detailed results for the batch operation
Results []*BatchResultItem `json:"results"`
}
Result of a batch operation.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/BatchResult).
type BatchResultItem ¶ added in v1.0.103
type BatchResultItem struct {
// The id of the item.
Id int64 `json:"id,omitempty"`
// Extra info
Msg string `json:"msg"`
// Indicates if the operation succeeded for this item
Succeeded bool `json:"succeeded"`
}
Result of a batch operation for a specific item.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/BatchResultItem).
type Contact ¶
type Contact struct {
// Contact ID
//
// Note: Ignored when creating a new contact.
//
// Note: Ignored when updating an existing contact.
Id int64 `json:"id"`
// Addresses
Addresses []*Address `json:"addresses"`
// App notifications
Appnotifications []int64 `json:"appnotifications"`
// App onboardingstatus
Apponboardingstatus int64 `json:"apponboardingstatus,omitempty"`
// App optin
Appoptin *Appoptin `json:"appoptin,omitempty"`
// App phone
Appphone string `json:"appphone,omitempty"`
// App token
Apptoken string `json:"apptoken,omitempty"`
// Birth date
Birthdate Time `json:"birthdate,omitempty"`
// Company
Company string `json:"company,omitempty"`
// Customer title ID (also determines the gender of the contact)
Customertitleid int64 `json:"customertitleid,omitempty"`
// E-mail address
Email string `json:"email"`
// First name
Firstname string `json:"firstname,omitempty"`
// Image url
Image string `json:"image,omitempty"`
// Language (ISO 639-1 code (http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes))
Languagecode string `json:"languagecode,omitempty"`
// Last name
Lastname string `json:"lastname,omitempty"`
// Related objects
Lookup map[string]interface{} `json:"lookup,omitempty"`
// Middle name
Middlename string `json:"middlename,omitempty"`
// A list of opt ins
Optins []*ContactOptIn `json:"optins"`
// Job function
Organizationfunction string `json:"organizationfunction,omitempty"`
// Phone numbers
Phonenumbers []*Phonenumber `json:"phonenumbers"`
// A list of contact relationships
Relationships []*ContactRelationship `json:"relationships"`
// Relation type IDs
Relationtypes []int64 `json:"relationtypes"`
Sendmail bool `json:"sendmail"`
// Sex
Sex string `json:"sex,omitempty"`
// Contact status
//
// Possible values:
//
// * deleted: Contact has been deleted
//
// * incomplete: Contact misses crucial account information
//
// * (blank): Normal contact
//
// Note: Ignored when creating a new contact.
//
// Note: Ignored when updating an existing contact.
Status string `json:"status"`
// Whether or not this contact is subscribed in the e-mail marketing integration
//
// Note: Ignored when creating a new contact.
//
// Note: Ignored when updating an existing contact.
Subscribed bool `json:"subscribed"`
// VAT Number (for organizations)
Vatnumber string `json:"vatnumber,omitempty"`
// Whether or not this contact has been deleted
//
// Note: Ignored when creating a new contact.
//
// Note: Ignored when updating an existing contact.
Isdeleted bool `json:"isdeleted"`
// Created timestamp
//
// Note: Ignored when creating a new contact.
//
// Note: Ignored when updating an existing contact.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new contact.
//
// Note: Ignored when updating an existing contact.
Lastupdatets Time `json:"lastupdatets"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A single contact.
More info: see the get operation (https://www.ticketmatic.com/docs/api/contacts/get) and the contacts endpoint (https://www.ticketmatic.com/docs/api/contacts).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Contact).
func (*Contact) MarshalJSON ¶
Custom marshaller with support for custom fields
func (*Contact) UnmarshalJSON ¶
Custom unmarshaller with support for custom fields
type ContactAddressType ¶
type ContactAddressType struct {
// Unique ID
//
// Note: Ignored when creating a new contact address type.
//
// Note: Ignored when updating an existing contact address type.
Id int64 `json:"id"`
// Name of the address type
Name string `json:"name"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new contact address type.
//
// Note: Ignored when updating an existing contact address type.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new contact address type.
//
// Note: Ignored when updating an existing contact address type.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new contact address type.
//
// Note: Ignored when updating an existing contact address type.
Lastupdatets Time `json:"lastupdatets"`
}
A single contact address type.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/contactaddresstypes/get) and the contact address types endpoint (https://www.ticketmatic.com/docs/api/settings/system/contactaddresstypes).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactAddressType).
type ContactAddressTypeQuery ¶
type ContactAddressTypeQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter contact address types.
More info: see contact address type (https://www.ticketmatic.com/docs/api/types/ContactAddressType), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/contactaddresstypes/getlist) and the contact address types endpoint (https://www.ticketmatic.com/docs/api/settings/system/contactaddresstypes).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactAddressTypeQuery).
type ContactBatchUpdate ¶ added in v1.0.33
type ContactBatchUpdate struct {
// Customer title ID (also determines the gender of the contact)
Customertitleid int64 `json:"customertitleid,omitempty"`
// Language (ISO 639-1 code (http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes))
Languagecode string `json:"languagecode,omitempty"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
Set of fields that can be used for contact batch update.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactBatchUpdate).
func (*ContactBatchUpdate) MarshalJSON ¶ added in v1.0.33
func (o *ContactBatchUpdate) MarshalJSON() ([]byte, error)
Custom marshaller with support for custom fields
func (*ContactBatchUpdate) UnmarshalJSON ¶ added in v1.0.33
func (o *ContactBatchUpdate) UnmarshalJSON(data []byte) error
Custom unmarshaller with support for custom fields
type ContactField ¶
type ContactField struct {
// Id of this ContactField
Id int64 `json:"id"`
// Name of this contactfield
Name string `json:"name"`
// Caption of this contactfield
Caption string `json:"caption"`
}
Contact field is a list of field that are asked upon registration
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactField).
type ContactGetQuery ¶
type ContactGetQuery struct {
// Contact e-mail address
Email string `json:"email,omitempty"`
}
Optional alternative methods to retrieve a contact
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactGetQuery).
type ContactIdReservation ¶ added in v1.0.36
type ContactIdReservation struct {
// Maximum ID to reserve
Id int64 `json:"id"`
}
Contact ID reservation
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactIdReservation).
type ContactImportStatus ¶ added in v1.0.32
type ContactImportStatus struct {
// Contact ID
Id int64 `json:"id"`
// Error message, if failed
Error string `json:"error"`
// Whether the import succeeded
Ok bool `json:"ok"`
}
Import status per contact
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactImportStatus).
type ContactOptIn ¶ added in v1.0.84
type ContactOptIn struct {
// Unique ID
Id int64 `json:"id"`
// Info on the actual opt in
Info *ContactOptInInfo `json:"info,omitempty"`
// ID of the optin
Optinid int64 `json:"optinid"`
// Status of the opt-in. Possible values are Unknown (7601), Opted In (7602) and
// Opted Out (7603)
Status int64 `json:"status"`
// Created timestamp
Createdts Time `json:"createdts"`
// Last updated timestamp
Lastupdatets Time `json:"lastupdatets"`
}
A single contact opt-in.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactOptIn).
type ContactOptInInfo ¶ added in v1.0.83
type ContactOptInInfo struct {
// The ip address from which the opt in is set.
Ip string `json:"ip"`
// The method by which the status is set
Method string `json:"method"`
// Explanation of why the status was set.
Remarks string `json:"remarks"`
// ID of the user that has set this opt in.
Userid int64 `json:"userid"`
}
Additional info when this opt in is set.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactOptInInfo).
type ContactQuery ¶
type ContactQuery struct {
// A SQL query that returns contact IDs
//
// Can be used to do arbitrary filtering. See the database documentation for
// contact (https://www.ticketmatic.com/docs/db/contact) for more information.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// Only include contacts that have been updated since the given timestamp.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
// Limit results to at most the given amount of contacts.
Limit int64 `json:"limit,omitempty"`
// Skip the first X contacts.
Offset int64 `json:"offset,omitempty"`
// Order by the given field.
//
// Supported values: name, lastupdatets, createdts.
Orderby string `json:"orderby,omitempty"`
// Output format.
//
// Possible values:
//
// * ids: Only fill the ID field
//
// * minimal: A minimal set of order fields
//
// * default: Return all order fields (also used when the output parameter is
// omitted)
Output string `json:"output,omitempty"`
// A text filter string.
//
// Matches against the contact name and contact details.
Searchterm string `json:"searchterm,omitempty"`
}
Filter parameters to fetch a list of contacts
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactQuery).
type ContactRelationship ¶ added in v1.0.118
type ContactRelationship struct {
// Contact relationship ID
Id int64 `json:"id"`
// The type of the relationship
Typeid int64 `json:"typeid"`
// The contact ID of the child
Childcontactid int64 `json:"childcontactid"`
// The contact ID of the parent
Parentcontactid int64 `json:"parentcontactid"`
}
Contact relationships
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactRelationship).
type ContactRemark ¶ added in v1.0.97
type ContactRemark struct {
// Remark ID
Id int64 `json:"id"`
// The message
Content string `json:"content"`
// Is this relevant for sales?
Pinned bool `json:"pinned"`
}
Remarks belonging to a contact.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactRemark).
type ContactTitle ¶
type ContactTitle struct {
// Unique ID
//
// Note: Ignored when creating a new contact title.
//
// Note: Ignored when updating an existing contact title.
Id int64 `json:"id"`
// Title name
Name string `json:"name"`
// Restricts this title from showing up on the websales pages
Isinternal bool `json:"isinternal"`
// Language for this title
Languagecode string `json:"languagecode"`
// Gender associated with this title
Sex string `json:"sex"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new contact title.
//
// Note: Ignored when updating an existing contact title.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new contact title.
//
// Note: Ignored when updating an existing contact title.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new contact title.
//
// Note: Ignored when updating an existing contact title.
Lastupdatets Time `json:"lastupdatets"`
}
A single contact title.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/contacttitles/get) and the contact titles endpoint (https://www.ticketmatic.com/docs/api/settings/system/contacttitles).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactTitle).
type ContactTitleQuery ¶
type ContactTitleQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter contact titles.
More info: see contact title (https://www.ticketmatic.com/docs/api/types/ContactTitle), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/contacttitles/getlist) and the contact titles endpoint (https://www.ticketmatic.com/docs/api/settings/system/contacttitles).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ContactTitleQuery).
type CreateOrder ¶
type CreateOrder struct {
// Event IDs that might end up in this order, used to hint the rate limiter
// (https://www.ticketmatic.com/docs/api/ratelimiting) of what might come.
Events []int64 `json:"events"`
// Product IDs that might end up in this order, used to hint the rate limiter
// (https://www.ticketmatic.com/docs/api/ratelimiting) of what might come.
Products []int64 `json:"products"`
// Sales channel in which this order is created
Saleschannelid int64 `json:"saleschannelid"`
}
Required data for creating an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/CreateOrder).
type CreateProduct ¶
type CreateProduct struct {
// The id for the product you want to add.
Productid int64 `json:"productid"`
// The property values for the product.
Properties map[string]string `json:"properties,omitempty"`
}
Info for adding a product (https://www.ticketmatic.com/docs/api/orders/addproducts) to an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/CreateProduct).
type CreateTicket ¶
type CreateTicket struct {
// The id for the optionbundle you want to add a new ticket to. Either
// tickettypepriceid or optionbundleid should be specified, not both.
Optionbundleid int64 `json:"optionbundleid,omitempty"`
// Manually select a specific ticket.
Ticketid int64 `json:"ticketid,omitempty"`
// Should only be specified when optionbundleid is specified. The tickettypeid for
// the ticket you want to add to the optionbundle.
Tickettypeid int64 `json:"tickettypeid,omitempty"`
// The ticket type price ID for the new ticket. Either tickettypepriceid or
// optionbundleid should be specified, not both.
Tickettypepriceid int64 `json:"tickettypepriceid,omitempty"`
// Voucher code to use (if any)
Vouchercode string `json:"vouchercode,omitempty"`
}
Info for adding a ticket (https://www.ticketmatic.com/docs/api/orders/addtickets) to an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/CreateTicket).
type CustomField ¶
type CustomField struct {
// Unique ID
//
// Note: Ignored when creating a new custom field.
//
// Note: Ignored when updating an existing custom field.
Id int64 `json:"id"`
// Type ID
//
// Note: Ignored when updating an existing custom field.
Typeid int64 `json:"typeid"`
// Rules that define in what conditions this custom field is available when edit
// type is checkout
Availability *CustomfieldAvailability `json:"availability,omitempty"`
// Human-readable name for the custom field
Caption string `json:"caption"`
// Human-readable description for the custom field. Will be visible for end-users
// when edittype checkout is used
Description string `json:"description"`
// Type of editing that is allowed for the custom field. Links to systemtype
// category 22xxx
Edittypeid int64 `json:"edittypeid"`
// Type of the custom field. Links to systemtype category 12xxx
Fieldtypeid int64 `json:"fieldtypeid"`
// The identifier for the custom field. Should contain only alphanumeric characters
// and no whitespace, max length is 30 characters. The custom field will be
// available in the api and the public data model as c_
Key string `json:"key"`
// Indicated whether the field is manually sortable
Manualsort bool `json:"manualsort"`
// Indicates where the custom field is required. Links to systemtype category 30xxx
Requiredtypeid int64 `json:"requiredtypeid"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new custom field.
//
// Note: Ignored when updating an existing custom field.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new custom field.
//
// Note: Ignored when updating an existing custom field.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new custom field.
//
// Note: Ignored when updating an existing custom field.
Lastupdatets Time `json:"lastupdatets"`
}
A single custom field.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/customfields/get) and the custom fields endpoint (https://www.ticketmatic.com/docs/api/settings/system/customfields).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/CustomField).
type CustomFieldQuery ¶
type CustomFieldQuery struct {
// Only return items with the given typeid.
Typeid int64 `json:"typeid"`
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter custom fields.
More info: see custom field (https://www.ticketmatic.com/docs/api/types/CustomField), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/customfields/getlist) and the custom fields endpoint (https://www.ticketmatic.com/docs/api/settings/system/customfields).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/CustomFieldQuery).
type CustomFieldValue ¶
type CustomFieldValue struct {
// Unique ID
//
// Note: Ignored when creating a new custom field value.
//
// Note: Ignored when updating an existing custom field value.
Id int64 `json:"id"`
// Type ID
//
// Note: Ignored when updating an existing custom field value.
Typeid int64 `json:"typeid"`
// Human-readable name for the value
Caption string `json:"caption"`
// Indicated the manual sort order
Sortorder int64 `json:"sortorder"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new custom field value.
//
// Note: Ignored when updating an existing custom field value.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new custom field value.
//
// Note: Ignored when updating an existing custom field value.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new custom field value.
//
// Note: Ignored when updating an existing custom field value.
Lastupdatets Time `json:"lastupdatets"`
}
A single custom field value.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/customfieldvalues/get) and the custom field values endpoint (https://www.ticketmatic.com/docs/api/settings/system/customfieldvalues).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/CustomFieldValue).
type CustomFieldValueQuery ¶
type CustomFieldValueQuery struct {
// Only return items with the given typeid.
Typeid int64 `json:"typeid,omitempty"`
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter custom field values.
More info: see custom field value (https://www.ticketmatic.com/docs/api/types/CustomFieldValue), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/customfieldvalues/getlist) and the custom field values endpoint (https://www.ticketmatic.com/docs/api/settings/system/customfieldvalues).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/CustomFieldValueQuery).
type CustomfieldAvailability ¶
type CustomfieldAvailability struct {
// The custom field will be available for these saleschannels. It this is empty the
// custom field will not be available.
Saleschannels []int64 `json:"saleschannels"`
// A Javascript that needs to return a boolean. It has the current order available.
Script string `json:"script"`
// Indicates if the script will be used.
Usescript bool `json:"usescript"`
}
A CustomfieldAvailability configures in what saleschannels a custom field is available (during the checkout).
It can also further refine the availability based on a script written in JavaScript.
More information about writing order scripts can be found here (https://www.ticketmatic.com/docs/tickets/configure_ticket_sales/orderfees).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/CustomfieldAvailability).
type DeleteProducts ¶
type DeleteProducts struct {
// Product IDs
Products []int64 `json:"products"`
}
Request data used to delete products (https://www.ticketmatic.com/docs/api/orders/deleteproducts) from an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/DeleteProducts).
type DeleteTickets ¶
type DeleteTickets struct {
// Ticket IDs
Tickets []int64 `json:"tickets"`
}
Request data used to delete tickets (https://www.ticketmatic.com/docs/api/orders/deletetickets) from an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/DeleteTickets).
type DeliveryScenario ¶
type DeliveryScenario struct {
// Unique ID
//
// Note: Ignored when creating a new delivery scenario.
//
// Note: Ignored when updating an existing delivery scenario.
Id int64 `json:"id"`
// The type of this delivery scenario, defines when this
// delivery scenario is triggered. The available values for
// this field can be found on the delivery scenario overview
// (https://www.ticketmatic.com/docs/api/settings/ticketsales/deliveryscenarios)
// page.
Typeid int64 `json:"typeid"`
// Name of the delivery scenario
Name string `json:"name"`
// Are e-tickets allowed with this delivery scenario?
Allowetickets int64 `json:"allowetickets"`
// The rules that define when this scenario is
// available. See the delivery scenario overview
// (https://www.ticketmatic.com/docs/api/settings/ticketsales/deliveryscenarios)
// page for a description of this field
//
// Note: Not set when retrieving a list of delivery scenarios.
Availability *DeliveryscenarioAvailability `json:"availability,omitempty"`
// The delivery status the order will transition to when the trigger occurs.
Deliverystatusaftertrigger int64 `json:"deliverystatusaftertrigger"`
// A very short description of the fee that is applicable.
Feedescription string `json:"feedescription"`
// An internal description field. Will not be shown to customers.
Internalremark string `json:"internalremark,omitempty"`
// Logo url
Logo string `json:"logo"`
// Send mail to organization if known
Mailorganization bool `json:"mailorganization"`
// A physical address is required
Needsaddress bool `json:"needsaddress"`
// The ID of the order mail template that will be used for sending out when
// changing to delivery state 'delivered'. Can be 0 to indicate that no mail should
// be sent
OrdermailtemplateidDelivery int64 `json:"ordermailtemplateid_delivery"`
// The ID of the order mail template that will be used for sending out when
// changing to delivery state 'delivery started'. Can be 0 to indicate that no mail
// should be sent
OrdermailtemplateidDeliverystarted int64 `json:"ordermailtemplateid_deliverystarted"`
// A short description of the deilvery scenario. Will be shown to customers.
Shortdescription string `json:"shortdescription"`
// Parameter that sets the visibility of this scenario, can be either 'FULL' or
// 'API'.
Visibility string `json:"visibility"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new delivery scenario.
//
// Note: Ignored when updating an existing delivery scenario.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new delivery scenario.
//
// Note: Ignored when updating an existing delivery scenario.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new delivery scenario.
//
// Note: Ignored when updating an existing delivery scenario.
Lastupdatets Time `json:"lastupdatets"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A single delivery scenario.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/ticketsales/deliveryscenarios/get) and the delivery scenarios endpoint (https://www.ticketmatic.com/docs/api/settings/ticketsales/deliveryscenarios).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/DeliveryScenario).
func (*DeliveryScenario) MarshalJSON ¶ added in v1.0.75
func (o *DeliveryScenario) MarshalJSON() ([]byte, error)
Custom marshaller with support for custom fields
func (*DeliveryScenario) UnmarshalJSON ¶ added in v1.0.75
func (o *DeliveryScenario) UnmarshalJSON(data []byte) error
Custom unmarshaller with support for custom fields
type DeliveryScenarioQuery ¶
type DeliveryScenarioQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter delivery scenarios.
More info: see delivery scenario (https://www.ticketmatic.com/docs/api/types/DeliveryScenario), the getlist operation (https://www.ticketmatic.com/docs/api/settings/ticketsales/deliveryscenarios/getlist) and the delivery scenarios endpoint (https://www.ticketmatic.com/docs/api/settings/ticketsales/deliveryscenarios).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/DeliveryScenarioQuery).
type DeliveryscenarioAvailability ¶
type DeliveryscenarioAvailability struct {
// An array of sales channel IDs for which this delivery scenario can be used
Saleschannels []int64 `json:"saleschannels"`
// Script used to determine availability of the delivery scenario
Script string `json:"script"`
// Use a script to refine the set of sales channels?
Usescript bool `json:"usescript"`
}
A DeliveryscenarioAvailability defines when a delivery scenario (https://www.ticketmatic.com/docs/api/types/DeliveryScenario) is available.
This can be done in two ways:
* By specifying a set of sales channels (required)
* By writing a script (optional)
In its simplest form, a DeliveryscenarioAvailability looks like this:
{
"saleschannels": [1, 2]
}
This defines that the delivery scenario is available when used in the context of saleschannel 1 or 2.
More complex logic can be specified by writing a small piece of JavaScript (http://en.wikipedia.org/wiki/JavaScript). To do so, you need to add a usescript and script field to the availability:
{
"saleschannels": [1, 2],
"usescript": true,
"script": "// script here"
}
Note that the list of sales channel IDs is still required: the script can only restrict this set further.
A simple example of a delivery scenario script:
return order.tickets.length < 3 && saleschannel.typeid == 3002;
This script states that the current delivery scenario is only available if the amount of tickets in the order is less than 3 and the current sales channel is a web sales channel.
With this script the DeliveryscenarioAvailability would look like this:
{
"saleschannels": [1, 2],
"usescript": true,
"script": "return order.tickets.length < 3 && saleschannel.typeid == 3002;"
}
The following variables are available in the script:
* order
* saleschannel
You can use any valid JavaScript syntax (including conditionals and loops). Note that each script has a strict time limit.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/DeliveryscenarioAvailability).
type Document ¶
type Document struct {
// Unique ID
//
// Note: Ignored when creating a new document.
//
// Note: Ignored when updating an existing document.
Id int64 `json:"id"`
// Type ID
//
// Note: Ignored when updating an existing document.
Typeid int64 `json:"typeid"`
// Name of the document
Name string `json:"name"`
// Css content for the document template
//
// Note: Not set when retrieving a list of documents.
Css string `json:"css"`
// Description of the document
Description string `json:"description"`
// Translations for the document template
Enabled bool `json:"enabled"`
// HTML content for the document template
//
// Note: Not set when retrieving a list of documents.
Htmltemplate string `json:"htmltemplate"`
// Key-value array of options. Can contain: nbrperpage
//
// Note: Not set when retrieving a list of documents.
Options *DocumentOptions `json:"options,omitempty"`
// Translations for the document template
//
// Note: Not set when retrieving a list of documents.
Translations map[string]string `json:"translations,omitempty"`
// Created timestamp
//
// Note: Ignored when creating a new document.
//
// Note: Ignored when updating an existing document.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new document.
//
// Note: Ignored when updating an existing document.
Lastupdatets Time `json:"lastupdatets"`
}
A single document.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/documents/get) and the documents endpoint (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/documents).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Document).
type DocumentOptions ¶ added in v1.0.118
type DocumentOptions struct {
// Amount of documents per page
Nbrperpage int64 `json:"nbrperpage"`
}
Options for the document generation.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/DocumentOptions).
type DocumentQuery ¶
type DocumentQuery struct {
// Only return items with the given typeid.
Typeid int64 `json:"typeid"`
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter documents.
More info: see document (https://www.ticketmatic.com/docs/api/types/Document), the getlist operation (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/documents/getlist) and the documents endpoint (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/documents).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/DocumentQuery).
type DupeDetectCriteria ¶ added in v1.0.81
type DupeDetectCriteria struct {
// The field on which to match
Field string `json:"field"`
// Matcher used for the specified field
Matcher string `json:"matcher"`
}
Dupe detect criteria define how fields are matched. See dupe detect rules (https://www.ticketmatic.com/docs/api/settings/system/dupedetectrules) for an overview of the possible field/matcher combinations.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/DupeDetectCriteria).
type DupeDetectRule ¶ added in v1.0.81
type DupeDetectRule struct {
// Unique ID
//
// Note: Ignored when creating a new dupe detect rule.
//
// Note: Ignored when updating an existing dupe detect rule.
Id int64 `json:"id"`
// Rule name
Name string `json:"name"`
// Criteria for matching
//
// Any contact that matches all of these criteria is listed as a match
Criteria []*DupeDetectCriteria `json:"criteria"`
// Created timestamp
//
// Note: Ignored when creating a new dupe detect rule.
//
// Note: Ignored when updating an existing dupe detect rule.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new dupe detect rule.
//
// Note: Ignored when updating an existing dupe detect rule.
Lastupdatets Time `json:"lastupdatets"`
}
A single dupe detect rule.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/dupedetectrules/get) and the dupe detect rules endpoint (https://www.ticketmatic.com/docs/api/settings/system/dupedetectrules).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/DupeDetectRule).
type DupeDetectRuleQuery ¶ added in v1.0.81
type DupeDetectRuleQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter dupe detect rules.
More info: see dupe detect rule (https://www.ticketmatic.com/docs/api/types/DupeDetectRule), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/dupedetectrules/getlist) and the dupe detect rules endpoint (https://www.ticketmatic.com/docs/api/settings/system/dupedetectrules).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/DupeDetectRuleQuery).
type Event ¶
type Event struct {
// Event ID
//
// Note: Ignored when creating a new event.
//
// Note: Ignored when updating an existing event.
Id int64 `json:"id,omitempty"`
// Event name
Name string `json:"name"`
// The audio preview url for the event
Audiopreviewurl string `json:"audiopreviewurl,omitempty"`
// Information on the availability of tickets per contingent. Read-only.
//
// Note: Ignored when creating a new event.
//
// Note: Ignored when updating an existing event.
Availability []*EventContingentAvailability `json:"availability"`
// Event code.
//
// Used as a unique identifier in web sales.
//
// Note: Ignored when creating a new event.
//
// Note: Ignored when updating an existing event.
Code string `json:"code,omitempty"`
// Information about the contingents in the Event that are not in the seatingplan
Contingents []*EventContingent `json:"contingents"`
// Event status
//
// The available values for this field can be found on the Event
// (https://www.ticketmatic.com/docs/api/types/Event) page.
Currentstatus int64 `json:"currentstatus,omitempty"`
// Description of the event, visible for ticket buyers
Description string `json:"description,omitempty"`
// Event end time
Endts Time `json:"endts"`
// External event code.
//
// This field is typically set when importing data from other systems.
Externalcode string `json:"externalcode,omitempty"`
// The image url for the event display image
//
// Note: Ignored when creating a new event.
//
// Note: Ignored when updating an existing event.
Image string `json:"image"`
// Practical info for the event, visible for ticket buyers
Info string `json:"info,omitempty"`
// Layout parameters for the event
Layout *Layout `json:"layout,omitempty"`
// Event location ID
//
// See event locations
// (https://www.ticketmatic.com/docs/api/settings/events/eventlocations) for more
// information.
Locationid int64 `json:"locationid,omitempty"`
// Event location name
//
// Automatically derived using locationid.
//
// Note: Ignored when creating a new event.
//
// Note: Ignored when updating an existing event.
Locationname string `json:"locationname,omitempty"`
// Maximum number of tickets for this event that can be added to a basket
Maxnbrofticketsperbasket int64 `json:"maxnbrofticketsperbasket,omitempty"`
// Opt-in set id
Optinsetid int64 `json:"optinsetid,omitempty"`
// Preview urls for the event.
Previews []*EventPreview `json:"previews"`
// Information on the available prices for the event
//
// Note: Ignored when creating a new event.
//
// Note: Ignored when updating an existing event.
Prices *EventPrices `json:"prices,omitempty"`
// Production ID
Productionid int64 `json:"productionid,omitempty"`
// Event publish time
//
// Note: Ignored when creating a new event.
//
// Note: Ignored when updating an existing event.
Publishedts Time `json:"publishedts,omitempty"`
// Queue ID
//
// See rate limiting (https://www.ticketmatic.com/docs/api/ratelimiting) for more
// information.
Queuetoken int64 `json:"queuetoken,omitempty"`
// DEPRECATED
Revenuesplitid int64 `json:"revenuesplitid,omitempty"`
// Time of end of sales.
//
// Used for all sales channels for which no specific sales period has been defined.
Saleendts Time `json:"saleendts,omitempty"`
// Per-sales channel information about when this event is for sale.
Saleschannels []*EventSalesChannel `json:"saleschannels"`
// Time of start of sales.
//
// Used for all sales channels for which no specific sales period has been defined.
Salestartts Time `json:"salestartts,omitempty"`
// Salestatus messages id
Salestatusmessagesid int64 `json:"salestatusmessagesid,omitempty"`
// Schedule for the event, visible for ticket buyers
Schedule string `json:"schedule,omitempty"`
// Allow or disallow leaving single seats on their own.
Seatallowsingle bool `json:"seatallowsingle,omitempty"`
SeatedChartkey string `json:"seated_chartkey"`
// Seated contingents
SeatedContingents []*EventContingent `json:"seated_contingents"`
// Information about the contingents defined in the seatingplan. Read-only.
//
// Note: Ignored when creating a new event.
//
// Note: Ignored when updating an existing event.
Seatingplancontingents []*EventSeatingplanContingent `json:"seatingplancontingents"`
// Event specific prices in addition to the prices defined in the field
// seatingplanpricelistid. Prices from the pricelist and the event specific prices
// are combined in one pricelist for the event. The optional position attribute
// defines where the event specific prices will be positioned in the resulting
// pricelist
Seatingplaneventspecificprices *PricelistPrices `json:"seatingplaneventspecificprices,omitempty"`
// Seating plan ID
//
// Only set for events with fixed seats.
Seatingplanid int64 `json:"seatingplanid,omitempty"`
// Name of the seatingplanlocktemplate to apply linking a seatingplanid to this
// event. This is not a numeric id but the name of the lock template as specified
// in the seatingplan's logicalplan.
//
// Note: Ignored when creating a new event.
//
// Note: Ignored when updating an existing event.
Seatingplanlocktemplate string `json:"seatingplanlocktemplate,omitempty"`
// Price list ID for fixed seats.
//
// Only set for events with fixed seats. See price lists
// (https://www.ticketmatic.com/docs/api/settings/pricing/pricelists) for more
// information.
Seatingplanpricelistid int64 `json:"seatingplanpricelistid,omitempty"`
// Enable or disable seat selection for customers.
Seatselection bool `json:"seatselection,omitempty"`
Segmentationtags []string `json:"segmentationtags"`
// servicemailids
Servicemailids []int64 `json:"servicemailids"`
// Short description of the event, visible for ticket buyers
Shortdescription string `json:"shortdescription,omitempty"`
// Social distance type. Determines if social distance must be practiced.
Socialdistance int64 `json:"socialdistance,omitempty"`
// Event start time
Startts Time `json:"startts"`
// Event subtitle
Subtitle string `json:"subtitle,omitempty"`
// Event subtitle (2)
Subtitle2 string `json:"subtitle2,omitempty"`
// Event tags
Tags []string `json:"tags"`
// Ticket fee ID
//
// Determines which ticket fee rules are used for this event. See ticket fees
// (https://www.ticketmatic.com/docs/api/settings/pricing/ticketfees) for more
// information.
Ticketfeeid int64 `json:"ticketfeeid,omitempty"`
// Ticketinfo id
Ticketinfoid int64 `json:"ticketinfoid,omitempty"`
// Ticket layout ID
//
// See ticket layouts
// (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ticketlayouts)
// for more information.
Ticketlayoutid int64 `json:"ticketlayoutid,omitempty"`
// Determines the total maximum amount of tickets that can be sold for event.
Totalmaxtickets int64 `json:"totalmaxtickets,omitempty"`
// Translation of event fields
Translations map[string]string `json:"translations,omitempty"`
// Upsell id
Upsellid int64 `json:"upsellid,omitempty"`
// The type of the waiting list the event uses
Waitinglisttype int64 `json:"waitinglisttype,omitempty"`
// Small description that will be shown on the sales pages of this event
Webremark string `json:"webremark,omitempty"`
// Created timestamp
//
// Note: Ignored when creating a new event.
//
// Note: Ignored when updating an existing event.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new event.
//
// Note: Ignored when updating an existing event.
Lastupdatets Time `json:"lastupdatets"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A single Event.
Status ¶
The currentstatus field of an event can have any of the following values:
* Draft (19001)
* Active (19002)
* Closed (19003)
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Event).
func (*Event) MarshalJSON ¶
Custom marshaller with support for custom fields
func (*Event) UnmarshalJSON ¶
Custom unmarshaller with support for custom fields
type EventContext ¶
type EventContext struct {
// The ID of the saleschannel used to restrict the event information
Saleschannelid int64 `json:"saleschannelid,omitempty"`
}
Used when requesting events, to restrict the event information to a specific context.
Currently allows you to filter the event information (both the events and the pricing information within each event) to a specific saleschannel. If a saleschannel is specified, only events that are currently for sale in that specific saleschannel will be returned.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventContext).
type EventContingent ¶
type EventContingent struct {
// Contingent ID
Id int64 `json:"id,omitempty"`
// Name of the contingent
Name string `json:"name"`
// Number of tickets in the contingent
Amount int64 `json:"amount"`
// Event ID
Eventid int64 `json:"eventid,omitempty"`
// Event specific prices in addition to the prices defined in the field
// pricelistid. Prices from the pricelist and the event specific prices are
// combined in one pricelist. The optional position attribute defines where the
// event specific prices will be positioned in the resulting pricelist
Eventspecificprices *PricelistPrices `json:"eventspecificprices,omitempty"`
// Locked tickets for the contingent
Locks []*EventContingentLock `json:"locks"`
// Price list ID for this contingent
Pricelistid int64 `json:"pricelistid,omitempty"`
// Whether the barcodes for the tickets in this contingent were imported (true),
// or were generated internally (false)
Withimportedbarcodes bool `json:"withimportedbarcodes,omitempty"`
}
Information about a contingent for an event (https://www.ticketmatic.com/docs/api/types/Event).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventContingent).
type EventContingentAvailability ¶
type EventContingentAvailability struct {
// Number of complimentary tickets
Complimentary int64 `json:"complimentary"`
// Number of available tickets
Free int64 `json:"free"`
// Number of locked tickets with a hard lock type
LockedHard int64 `json:"locked_hard"`
// Number of locked tickets with a soft lock type
LockedSoft int64 `json:"locked_soft"`
// Number of tickets reserved in unconfirmed orders
Reserved int64 `json:"reserved"`
// Number of tickets in confirmed orders that are completely paid
SoldPaid int64 `json:"sold_paid"`
// Number of tickets in confirmed orders that are not completely paid
SoldUnpaid int64 `json:"sold_unpaid"`
// Contingent ID
Tickettypeid int64 `json:"tickettypeid"`
// Total number of tickets in the contingent
Total int64 `json:"total"`
// Last updated timestamp
Lastupdatets Time `json:"lastupdatets"`
}
Information about the availability of tickets for a contingent
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventContingentAvailability).
type EventContingentLock ¶
type EventContingentLock struct {
// Number of tickets in the contingent
Amount int64 `json:"amount"`
// Lock type ID
Locktypeid int64 `json:"locktypeid"`
// Contingent ID
Tickettypeid int64 `json:"tickettypeid"`
}
Information about locked tickets in a Contingent.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventContingentLock).
type EventFilter ¶
type EventFilter struct {
// The ID of the production
Productionid int64 `json:"productionid,omitempty"`
// The event status. By default, events with status Active or Closed will be
// returned
Status []int64 `json:"status"`
}
Used when requesting events, to filter events.
Currently allows you to filter based on the production ID.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventFilter).
type EventLocation ¶
type EventLocation struct {
// Unique ID
//
// Note: Ignored when creating a new event location.
//
// Note: Ignored when updating an existing event location.
Id int64 `json:"id"`
// Name of the location
Name string `json:"name"`
// City
City string `json:"city"`
// Country code. Should be an ISO 3166-1 alpha-2
// (http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) two-letter code.
Countrycode string `json:"countrycode"`
// Geocode status for the address of this location.
Geostatus int64 `json:"geostatus"`
// Practical info on the event location (route description, public transport,
// parking,...).
Info string `json:"info"`
// Lat coordinate for the event location
//
// Note: Ignored when creating a new event location.
//
// Note: Ignored when updating an existing event location.
Lat float64 `json:"lat"`
// Long coordinate for the event location
//
// Note: Ignored when creating a new event location.
//
// Note: Ignored when updating an existing event location.
Long float64 `json:"long"`
// State
State string `json:"state"`
// Street name
Street1 string `json:"street1"`
// Nr. + Box
Street2 string `json:"street2"`
// Zipcode
Zip string `json:"zip"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new event location.
//
// Note: Ignored when updating an existing event location.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new event location.
//
// Note: Ignored when updating an existing event location.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new event location.
//
// Note: Ignored when updating an existing event location.
Lastupdatets Time `json:"lastupdatets"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A single event location.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/events/eventlocations/get) and the event locations endpoint (https://www.ticketmatic.com/docs/api/settings/events/eventlocations).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventLocation).
func (*EventLocation) MarshalJSON ¶ added in v1.0.75
func (o *EventLocation) MarshalJSON() ([]byte, error)
Custom marshaller with support for custom fields
func (*EventLocation) UnmarshalJSON ¶ added in v1.0.75
func (o *EventLocation) UnmarshalJSON(data []byte) error
Custom unmarshaller with support for custom fields
type EventLocationQuery ¶
type EventLocationQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter event locations.
More info: see event location (https://www.ticketmatic.com/docs/api/types/EventLocation), the getlist operation (https://www.ticketmatic.com/docs/api/settings/events/eventlocations/getlist) and the event locations endpoint (https://www.ticketmatic.com/docs/api/settings/events/eventlocations).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventLocationQuery).
type EventLockTickets ¶
type EventLockTickets struct {
// Id of the locktype to use for the lock.
Locktypeid int64 `json:"locktypeid"`
// Array of ticketids to lock.
Ticketids []int64 `json:"ticketids"`
}
Used when locking a set of tickets. Contains the locktypeid and the set of ticketids
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventLockTickets).
type EventPreview ¶ added in v1.0.82
type EventPreview struct {
// Link url
Linkurl string `json:"linkurl,omitempty"`
// Link to preview image
Previewimage string `json:"previewimage,omitempty"`
// Preview subtitle
Subtitle string `json:"subtitle,omitempty"`
// Preview title
Title string `json:"title,omitempty"`
// Preview type. Currently supported values are: itunes (30001), youtube (30002),
// soundcloud (30003)
Type int64 `json:"type,omitempty"`
// Preview url
Url string `json:"url,omitempty"`
}
Preview information for an event (https://www.ticketmatic.com/docs/api/types/Event).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventPreview).
type EventPrices ¶
type EventPrices struct {
// Price information for the contingents
Contingents []*EventPricesContingent `json:"contingents"`
}
Information about the prices for an event.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventPrices).
type EventPricesContingent ¶
type EventPricesContingent struct {
// Contingent ID
Contingentid int64 `json:"contingentid"`
// Price information for the pricetypes
Pricetypes []*EventPricesPricetype `json:"pricetypes"`
}
Information about the prices for a contingent for an event.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventPricesContingent).
type EventPricesCost ¶
type EventPricesCost struct {
// The actual cost
Cost float64 `json:"cost"`
// Cost ID
Costid int64 `json:"costid"`
}
Information about costs for a price for an event.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventPricesCost).
type EventPricesPricetype ¶
type EventPricesPricetype struct {
// Pricetype ID
Pricetypeid int64 `json:"pricetypeid"`
// Price information for this pricetype for the different sales channels
Saleschannels []*EventPricesSaleschannel `json:"saleschannels"`
// Ticket type price ID, used to add tickets to an order
Tickettypepriceid int64 `json:"tickettypepriceid"`
}
Information about the price for a pricetype for the specific sales channel for an event.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventPricesPricetype).
type EventPricesSaleschannel ¶
type EventPricesSaleschannel struct {
// Extra conditions for this price. This can be a promocode, a ticketlimit per
// order, ... .
Conditions []*PricelistPriceCondition `json:"conditions"`
// The costs associated with this price
Costs []*EventPricesCost `json:"costs"`
// The actual price
Price float64 `json:"price"`
// Saleschannel ID
Saleschannelid int64 `json:"saleschannelid"`
// The actual servicecharge
Servicecharge float64 `json:"servicecharge"`
// Tickettypeprice ID
Tickettypepriceid int64 `json:"tickettypepriceid"`
}
Information about the price for a pricetype for the specific sales channel for an event.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventPricesSaleschannel).
type EventQuery ¶
type EventQuery struct {
// Restrict the event information to a specific context.
//
// Currently allows you to filter the event information (both the events and the
// pricing information within each event) to a specific saleschannel. This makes it
// very easy to show the correct information on a website.
Context *EventContext `json:"context,omitempty"`
// A SQL query that returns event IDs
//
// Can be used to do arbitrary filtering. See the database documentation for event
// (https://www.ticketmatic.com/docs/db/event) for more information.
Filter string `json:"filter,omitempty"`
// Only include events that have been updated since the given timestamp.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
// Limit results to at most the given amount of events.
Limit int64 `json:"limit,omitempty"`
// Skip the first X events.
Offset int64 `json:"offset,omitempty"`
// Order by the given field.
//
// Supported values: name, startts.
Orderby string `json:"orderby,omitempty"`
// Output format.
//
// Possible values:
//
// * ids: Only fill the ID field
//
// * default: Return all event fields (also used when the output parameter is
// omitted)
//
// * withlookup: Returns all event fields and an additional lookup field which
// contains all dependent objects
Output string `json:"output,omitempty"`
// A text filter string.
//
// Matches against the start of the event name, the production name or the
// subtitle.
Searchterm string `json:"searchterm,omitempty"`
// Filters the events based on a given set of fields. Currently supports:
// productionid, status and pricetypeids.
Simplefilter *EventFilter `json:"simplefilter,omitempty"`
}
Filter parameters to fetch a list of events
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventQuery).
type EventSalesChannel ¶
type EventSalesChannel struct {
// Event ID
Eventid int64 `json:"eventid"`
// Whether or not this sales channels has a waiting list for this event
Haswaitinglist bool `json:"haswaitinglist"`
// Whether or not this sales channel is active for this event
Isactive bool `json:"isactive"`
// When the sales end
Saleendts Time `json:"saleendts"`
// Sales channel ID
Saleschannelid int64 `json:"saleschannelid"`
// When the sales start
Salestartts Time `json:"salestartts"`
}
Information about the sales period for a specific sales channel (https://www.ticketmatic.com/docs/api/types/SalesChannel) in an event (https://www.ticketmatic.com/docs/api/types/Event).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventSalesChannel).
type EventScanTicketsOut ¶ added in v1.0.51
type EventScanTicketsOut struct {
// Array of tickettypeids
Tickettypeids []int64 `json:"tickettypeids"`
}
Scan out all tickets that are scanned in
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventScanTicketsOut).
type EventSeatingplanContingent ¶
type EventSeatingplanContingent struct {
// Contingent ID
Id int64 `json:"id"`
// Name of the contingent
Name string `json:"name"`
// Number of tickets in the contingent
Amount int64 `json:"amount"`
// Event ID
Eventid int64 `json:"eventid"`
// Seat rank ID
Seatrankid int64 `json:"seatrankid"`
}
Information about a contingent in the seating plan for an event (https://www.ticketmatic.com/docs/api/types/Event).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventSeatingplanContingent).
type EventTicket ¶
type EventTicket struct {
// Ticket ID
Id int64 `json:"id"`
// Link to the order the ticket is contained in
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Orderid int64 `json:"orderid,omitempty"`
// The id of the scanner used for the last succesful entry
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Accesscontrollastenteredscandeviceid int64 `json:"accesscontrollastenteredscandeviceid,omitempty"`
// The timestamp of the last succesful entry with this ticket
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Accesscontrollastenteredts Time `json:"accesscontrollastenteredts,omitempty"`
// The id of the scanner used for the last succesful exit
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Accesscontrollastexitscandeviceid int64 `json:"accesscontrollastexitscandeviceid,omitempty"`
// The timestamp of the last succesful exit with this ticket
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Accesscontrollastexitts Time `json:"accesscontrollastexitts,omitempty"`
// The access control status for this ticket. 0 means not scanned, 1 means
// succesful entry, 2 means succesful exit
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Accesscontrolstatus int64 `json:"accesscontrolstatus,omitempty"`
// Ticket barcode
Barcode string `json:"barcode,omitempty"`
// Link to the bundle (orderproduct) that this ticket belongs to.
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Bundleid int64 `json:"bundleid,omitempty"`
// Link to the locktype used for locking the ticket
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Locktypeid int64 `json:"locktypeid,omitempty"`
// Fee for the ticket in the order
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Orderfee float64 `json:"orderfee,omitempty"`
// Price for the ticket in the order (without fee)
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Price float64 `json:"price,omitempty"`
// String to string key-value mapping of properties
Properties map[string]string `json:"properties,omitempty"`
// The seat description for this ticket (only for seated tickets)
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Seatdescription string `json:"seatdescription,omitempty"`
// Seat ID (for seated tickets)
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Seatid string `json:"seatid,omitempty"`
// Number indicating the priority for this ticket for the best available algorithm.
// Tickets with a higher priority will be considered first when performing a best
// available allocation.
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Seatpriority int64 `json:"seatpriority,omitempty"`
// Row number for the ticket (only for seated tickets)
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Seatrownumber string `json:"seatrownumber,omitempty"`
// Seat number for the ticket (only for seated tickets)
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Seatseatnumber string `json:"seatseatnumber,omitempty"`
// Optional seatzone for the ticket
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Seatzoneid int64 `json:"seatzoneid,omitempty"`
// Zone name for the ticket (only for seated tickets)
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Seatzonename string `json:"seatzonename,omitempty"`
// Optional link to the contact that is the ticketholder for this ticket
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Ticketholderid int64 `json:"ticketholderid,omitempty"`
// Optional name on the ticket
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Ticketname string `json:"ticketname,omitempty"`
// Link to the contingent this ticket belongs to
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Tickettypeid int64 `json:"tickettypeid,omitempty"`
// Link to the tickettypeprice that is assigned to this ticket for the order.
// Through the tickettypeprice you can retrieve the pricetype
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Tickettypepriceid int64 `json:"tickettypepriceid,omitempty"`
// Link to the vouchercode that was used to reserve this ticket.
//
// Note: Ignored in the result for updating tickets
//
// Note: Ignored when updating tickets
Vouchercodeid int64 `json:"vouchercodeid,omitempty"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A single ticket.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventTicket).
func (*EventTicket) MarshalJSON ¶
func (o *EventTicket) MarshalJSON() ([]byte, error)
Custom marshaller with support for custom fields
func (*EventTicket) UnmarshalJSON ¶
func (o *EventTicket) UnmarshalJSON(data []byte) error
Custom unmarshaller with support for custom fields
type EventTicketFilter ¶
type EventTicketFilter struct {
// The ID of the tickettype (contingent)
Tickettypeid int64 `json:"tickettypeid,omitempty"`
}
Used when requesting tickets for an event, to filter the tickets.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventTicketFilter).
type EventTicketQuery ¶
type EventTicketQuery struct {
// Filters the tickets based on a given set of fields.
Simplefilter *EventTicketFilter `json:"simplefilter,omitempty"`
}
Filter parameters to fetch a list of tickets for an event
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventTicketQuery).
type EventUnlockTickets ¶
type EventUnlockTickets struct {
// Array of ticketids to unlock.
Ticketids []int64 `json:"ticketids"`
}
Used when unlocking a set of tickets.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventUnlockTickets).
type EventUpdateSeatRankForTickets ¶ added in v1.0.30
type EventUpdateSeatRankForTickets struct {
// The seat rank
Seatrankid int64 `json:"seatrankid"`
// Array of ticketids to unlock.
Ticketids []int64 `json:"ticketids"`
}
Used when updating the seat rank for a set of tickets.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventUpdateSeatRankForTickets).
type EventUpsellitem ¶ added in v1.0.118
type EventUpsellitem struct {
// Id of the linked item
Id int64 `json:"id,omitempty"`
// Upsellitem type. Currently supported values are: event, product
Type string `json:"type,omitempty"`
}
Upsell items for the event.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventUpsellitem).
type EventstreamItem ¶ added in v1.0.118
type EventstreamItem struct {
// Id of the event
Id string `json:"id"`
// Eventstream data
Data map[string]interface{} `json:"data,omitempty"`
// ISO-8601 timestamp of the event
Ts string `json:"ts"`
// Eventstream item type
Type string `json:"type"`
}
Results of polling the stream
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventstreamItem).
type EventstreamRequest ¶ added in v1.0.118
type EventstreamRequest struct {
// Minimum id to start reading the stream
Id string `json:"id"`
// Comma separated list of event types to filter on
Eventtypes string `json:"eventtypes"`
// Timestamp in ISO-8601 format to start reading the stream, mutually exclusive
// with the id
Ts string `json:"ts"`
}
Parameters for requesting eventstream events
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventstreamRequest).
type EventstreamResult ¶ added in v1.0.118
type EventstreamResult struct {
// The stream possibly contains more events, polling might need to catch up
Moreresults bool `json:"moreresults"`
// Id to use as startid in next poll
Nextid string `json:"nextid"`
// The results of polling the stream
Results []*EventstreamItem `json:"results"`
}
Result of polling the eventstream.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/EventstreamResult).
type FieldDefinition ¶
type FieldDefinition struct {
// Unique ID
//
// Note: Ignored when creating a new field definition.
//
// Note: Ignored when updating an existing field definition.
Id int64 `json:"id"`
// Type ID
//
// Note: Ignored when updating an existing field definition.
Typeid int64 `json:"typeid"`
// Alignment of the field definition, when used in a view. Values can be 'left',
// 'right' or 'center'
Align string `json:"align"`
// Human-readable name for the field definition
Description string `json:"description"`
// Key for the field definition. Should only consist of lowercase alphanumeric
// characters
Key string `json:"key"`
// The actual definition of the field definition. Contains the sql clause that will
// retrieve the information element in the database.
Sqlclause string `json:"sqlclause"`
// Will decide how the field will be rendered when used in a view.
Uitype string `json:"uitype"`
// Indicates whether the width for the field definition can be adapted when
// stretching a view that includes the field definition across the whole available
// width.
Variablewidth bool `json:"variablewidth"`
// Width of the field definition, when used in a view
Width int64 `json:"width"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new field definition.
//
// Note: Ignored when updating an existing field definition.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new field definition.
//
// Note: Ignored when updating an existing field definition.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new field definition.
//
// Note: Ignored when updating an existing field definition.
Lastupdatets Time `json:"lastupdatets"`
}
A single field definition.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/fielddefinitions/get) and the field definitions endpoint (https://www.ticketmatic.com/docs/api/settings/system/fielddefinitions).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/FieldDefinition).
type FieldDefinitionQuery ¶
type FieldDefinitionQuery struct {
// Only return items with the given typeid.
Typeid int64 `json:"typeid,omitempty"`
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter field definitions.
More info: see field definition (https://www.ticketmatic.com/docs/api/types/FieldDefinition), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/fielddefinitions/getlist) and the field definitions endpoint (https://www.ticketmatic.com/docs/api/settings/system/fielddefinitions).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/FieldDefinitionQuery).
type FielddefinitionsDataRequest ¶ added in v1.0.89
type FielddefinitionsDataRequest struct {
// Type id
Typeid int64 `json:"typeid"`
// Keys for field definitions to retrieve
Fielddefinitions []string `json:"fielddefinitions"`
// Item ids
Ids []int64 `json:"ids"`
}
Info for requesting field definition data for one or more items.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/FielddefinitionsDataRequest).
type FielddefinitionsDataResult ¶ added in v1.0.89
type FielddefinitionsDataResult struct {
// Item id
Id int64 `json:"id"`
// Field definition data for the item
Data map[string]interface{} `json:"data,omitempty"`
}
Data for field definitions for an item.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/FielddefinitionsDataResult).
type FilterDefinition ¶
type FilterDefinition struct {
// Unique ID
//
// Note: Ignored when creating a new filter definition.
//
// Note: Ignored when updating an existing filter definition.
Id int64 `json:"id"`
// Type ID
//
// Note: Ignored when updating an existing filter definition.
Typeid int64 `json:"typeid"`
// For certain filter types, the user must select a value from a list. The
// checklistquery contains the sql clause to retrieve the list of available values.
Checklistquery string `json:"checklistquery"`
// Name for the filter
Description string `json:"description"`
// The type of filter definition defines the UI and resulting parameters that will
// be used when a user selects the filter. The possible values can be found here
// (https://www.ticketmatic.com/docs/api/settings/system/filterdefinitions).
Filtertype int64 `json:"filtertype"`
// The sql clause that defines how the filter will work
Sqlclause string `json:"sqlclause"`
// Disable or enable filter
Visible bool `json:"visible"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new filter definition.
//
// Note: Ignored when updating an existing filter definition.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new filter definition.
//
// Note: Ignored when updating an existing filter definition.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new filter definition.
//
// Note: Ignored when updating an existing filter definition.
Lastupdatets Time `json:"lastupdatets"`
}
A single filter definition.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/filterdefinitions/get) and the filter definitions endpoint (https://www.ticketmatic.com/docs/api/settings/system/filterdefinitions).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/FilterDefinition).
type FilterDefinitionQuery ¶
type FilterDefinitionQuery struct {
// Only return items with the given typeid.
Typeid int64 `json:"typeid"`
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter filter definitions.
More info: see filter definition (https://www.ticketmatic.com/docs/api/types/FilterDefinition), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/filterdefinitions/getlist) and the filter definitions endpoint (https://www.ticketmatic.com/docs/api/settings/system/filterdefinitions).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/FilterDefinitionQuery).
type FilterItem ¶ added in v1.0.51
type FilterItem struct {
// Filter ID
//
// Indicates which filter is used in this operator
Id int64 `json:"id"`
// Operator type
Operator string `json:"operator"`
}
Element of a filter
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/FilterItem).
type Flowinfo ¶ added in v1.0.99
type Flowinfo struct {
// Contact id
Contactid int64 `json:"contactid"`
// Order active in the flow
Order *Order `json:"order,omitempty"`
// Reason the user was redirected
Reason string `json:"reason"`
}
Info about a finished flow
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Flowinfo).
type Flowsession ¶ added in v1.0.98
type Flowsession struct {
// Order id
Orderid int64 `json:"orderid"`
// Contact id
Contactid int64 `json:"contactid"`
}
Required data for a flow session
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Flowsession).
type ImportBundleTicket ¶
type ImportBundleTicket struct {
// Manually select a specific ticket.
Id int64 `json:"id,omitempty"`
// If boolean is set to true, the price field is used (even if set to 0) to
// determine the price for this ticket
Overrideprice bool `json:"overrideprice,omitempty"`
// The price for this bundle ticket, if this value is greater than 0 it's always
// used. If one of the bundletickets has a price, all bundletickets should have a
// price. Setting this overrides the default behaviour of the configured bundle.
Price float64 `json:"price,omitempty"`
// Seatzone ID
Seatzoneid int64 `json:"seatzoneid,omitempty"`
// The tickettype ID for the ticket.
Tickettypeid int64 `json:"tickettypeid"`
// The tickettypeprice ID for the ticket. This field is required if bundletickets
// are specified for a fixed bundle. When importing an optionbundle, if one of
// the bundletickets has a tickettypepriceid, all bundletickets should have one.
// Setting this, overrides the default behaviour of the configured bundle
Tickettypepriceid int64 `json:"tickettypepriceid,omitempty"`
}
Used when importing an order with optiondbundle tickets
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ImportBundleTicket).
type ImportOrder ¶
type ImportOrder struct {
// Order ID
Orderid int64 `json:"orderid"`
// Order code
//
// Used as a unique identifier in web sales.
Code string `json:"code,omitempty"`
// Customer ID
Customerid int64 `json:"customerid,omitempty"`
// Address used when delivering physically
Deliveryaddress *Address `json:"deliveryaddress,omitempty"`
// See delivery scenarios
// (https://www.ticketmatic.com/docs/api/settings/ticketsales/deliveryscenarios)
// for more info.
Deliveryscenarioid int64 `json:"deliveryscenarioid,omitempty"`
// Delivery status
//
// Possible values:
//
// * 2601: Not delivered
//
// * 2602: Delivered
//
// * 2603: Changed after delivery
Deliverystatus int64 `json:"deliverystatus,omitempty"`
// Indicates if the expired order has been handled. If set to false when importing,
// Ticketmatic will send our expiry mails if configured.
Expiryhandled bool `json:"expiryhandled,omitempty"`
// When the order will expire. If this is specified expiryhandled should also be
// specified.
Expiryts Time `json:"expiryts,omitempty"`
// Order fees for the order
Ordercosts []*ImportOrdercost `json:"ordercosts"`
// Payments in the order
Payments []*ImportPayment `json:"payments"`
// See payment scenarios
// (https://www.ticketmatic.com/docs/api/settings/ticketsales/paymentscenarios) for
// more info.
Paymentscenarioid int64 `json:"paymentscenarioid,omitempty"`
// Products in the order
Products []*ImportProduct `json:"products"`
// Indicates if the overdue order has been handled. If set to false when importing,
// Ticketmatic will send our reminder mails if configured.
Rappelhandled bool `json:"rappelhandled,omitempty"`
// When a reminder mail will be sent. If this is specified rappelhandled should
// also be specified.
Rappelts Time `json:"rappelts,omitempty"`
// See sales channels
// (https://www.ticketmatic.com/docs/api/settings/ticketsales/saleschannels) for
// more info.
Saleschannelid int64 `json:"saleschannelid"`
// Tickets in the order
Tickets []*ImportTicket `json:"tickets"`
// Created timestamp
Createdts Time `json:"createdts,omitempty"`
// Last updated timestamp
Lastupdatets Time `json:"lastupdatets,omitempty"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
Used to import an order.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ImportOrder).
func (*ImportOrder) MarshalJSON ¶ added in v1.0.37
func (o *ImportOrder) MarshalJSON() ([]byte, error)
Custom marshaller with support for custom fields
func (*ImportOrder) UnmarshalJSON ¶ added in v1.0.37
func (o *ImportOrder) UnmarshalJSON(data []byte) error
Custom unmarshaller with support for custom fields
type ImportOrdercost ¶
type ImportOrdercost struct {
// The amount for this ordercost, can only be specified with manual ordercosts
Amount float64 `json:"amount,omitempty"`
// Id of the service charge to use for this ordercost
Servicechargedefinitionid int64 `json:"servicechargedefinitionid"`
}
Used when importing orders.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ImportOrdercost).
type ImportPayment ¶
type ImportPayment struct {
// Amount
Amount float64 `json:"amount"`
// Timestamp of payment
Paidts Time `json:"paidts"`
// Payment method id
Paymentmethodid int64 `json:"paymentmethodid"`
// Additional properties for the payment. Can contain a variable structure.
Properties map[string]interface{} `json:"properties,omitempty"`
// Voucher code that was used for this payment
Vouchercode string `json:"vouchercode,omitempty"`
// Voucher code id that was used for this payment
Vouchercodeid int64 `json:"vouchercodeid,omitempty"`
}
Used when importing an order.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ImportPayment).
type ImportProduct ¶
type ImportProduct struct {
// List of tickets that belong to this bundle.
Bundletickets []*ImportBundleTicket `json:"bundletickets"`
// If boolean is set to true, the price field is used (even if set to 0) to
// determine the price for this product
Overrideprice bool `json:"overrideprice,omitempty"`
// Product price, will always be used if larger than 0.
Price float64 `json:"price,omitempty"`
// Indicate which contact is the holder of this product. Currently only used with
// bundles.
Productholderid int64 `json:"productholderid,omitempty"`
// The id for the product you want to add.
Productid int64 `json:"productid"`
// The property values for the product.
Properties map[string]string `json:"properties,omitempty"`
// If this product references a voucher, set the amount to reserve for this
// voucher.
Voucheramount float64 `json:"voucheramount,omitempty"`
// If this product references a voucher, set the code for the voucher that will be
// created. If not set, the code will be generated.
Vouchercode string `json:"vouchercode,omitempty"`
// If this product references a voucher, set the expiry timestamp for the
// vouchercode that will be created. If not set, the default timestamp configured
// in the voucher will be set.
Voucherexpiryts Time `json:"voucherexpiryts,omitempty"`
}
Used when importing orders.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ImportProduct).
type ImportTicket ¶
type ImportTicket struct {
// Manually select a specific ticket.
Id int64 `json:"id,omitempty"`
// If boolean is set to true, the price field is used (even if set to 0) to
// determine the price for this ticket
Overrideprice bool `json:"overrideprice,omitempty"`
// If boolean is set to true, the servicecharge field is used (even if set to 0) to
// determine the servicecharge for this ticket
Overrideservicecharge bool `json:"overrideservicecharge,omitempty"`
// Ticket price, will always be used if larger then 0.
Price float64 `json:"price,omitempty"`
// Seatzone ID
Seatzoneid int64 `json:"seatzoneid,omitempty"`
// Service charge for this ticket
Servicecharge float64 `json:"servicecharge,omitempty"`
// If this ticket should be linked to a contact, set the ticketholderid
Ticketholderid int64 `json:"ticketholderid,omitempty"`
// DEPRECATED: Use ticketholderid
Ticketholdername string `json:"ticketholdername,omitempty"`
// The tickettype ID for the ticket.
Tickettypeid int64 `json:"tickettypeid"`
// The ticket type price ID for the new ticket. Either tickettypepriceid or
// optionbundleid should be specified, not both.
Tickettypepriceid int64 `json:"tickettypepriceid,omitempty"`
// Voucher code to use (if any)
Vouchercode string `json:"vouchercode,omitempty"`
// The voucher code to link to this ticket
Vouchercodeid int64 `json:"vouchercodeid,omitempty"`
}
Used when importing order.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ImportTicket).
type JobResult ¶ added in v1.0.45
type JobResult struct {
// Id of the job
Id string `json:"id"`
// Job name
Name string `json:"name"`
// Job progress (percentage)
Progress int64 `json:"progress"`
// Current progress of the job as string
Progresstext string `json:"progresstext"`
// Status for the job
Status int64 `json:"status"`
}
Info on a job.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/JobResult).
type KeyValueItem ¶
Key-value item
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/KeyValueItem).
type Layout ¶ added in v1.0.118
type Layout struct {
// Main color for the event
Color string `json:"color,omitempty"`
// Use image in max format
MaxImage bool `json:"maxImage,omitempty"`
}
Layout parameters
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Layout).
type LockTemplate ¶ added in v1.0.31
type LockTemplate struct {
// The name of the template
Name string `json:"name"`
// A map where seat id is the key and the lock type is the value
Seats map[string]int64 `json:"seats,omitempty"`
}
The lock templates contain a mapping of which type of lock is applied to which seats
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/LockTemplate).
type LockType ¶
type LockType struct {
// Unique ID
//
// Note: Ignored when creating a new lock type.
//
// Note: Ignored when updating an existing lock type.
Id int64 `json:"id"`
// Name for the lock type
Name string `json:"name"`
// The color of the lock type
Color string `json:"color"`
// Hides seats in online sales if this is true
Hideseats bool `json:"hideseats"`
// Indicates whether this lock is a hard lock (meaning that it normally never will
// be released and does not count for the inventory) or a soft lock
Ishardlock bool `json:"ishardlock"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new lock type.
//
// Note: Ignored when updating an existing lock type.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new lock type.
//
// Note: Ignored when updating an existing lock type.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new lock type.
//
// Note: Ignored when updating an existing lock type.
Lastupdatets Time `json:"lastupdatets"`
}
A single lock type.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/ticketsales/locktypes/get) and the lock types endpoint (https://www.ticketmatic.com/docs/api/settings/ticketsales/locktypes).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/LockType).
type LockTypeQuery ¶
type LockTypeQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter lock types.
More info: see lock type (https://www.ticketmatic.com/docs/api/types/LockType), the getlist operation (https://www.ticketmatic.com/docs/api/settings/ticketsales/locktypes/getlist) and the lock types endpoint (https://www.ticketmatic.com/docs/api/settings/ticketsales/locktypes).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/LockTypeQuery).
type LogItem ¶
type LogItem struct {
// Id of the log item
Id int64 `json:"id"`
// Order id
Orderid int64 `json:"orderid"`
// Log item type
Typeid int64 `json:"typeid"`
// Info
Info map[string]interface{} `json:"info,omitempty"`
// Lookup info
Lookupinfo map[string]interface{} `json:"lookupinfo,omitempty"`
// Model
Model map[string]interface{} `json:"model,omitempty"`
// Log item timestamp
Ts Time `json:"ts"`
// User id
Userid int64 `json:"userid"`
// User name
Username string `json:"username"`
}
Log item returned when requesting the log history of an order (https://www.ticketmatic.com/docs/api/types/Order).
Type ¶
The typeid field of an order log can have any of the following values:
* Create order (18001)
* Remove order (18002)
* Add tickets (18003)
* Remove tickets (18004)
* Update tickets (18005)
* Confirm order (18006)
* Link customer (18007)
* Remove customer (18008)
* Move tickets (18009)
* Update price type (18010)
* Add payment (18011)
* Set payment scenario (18012)
* Set delivery scenario (18013)
* Order delivered (18014)
* Mail sent (18015)
* Custom fields updated (18016)
* Rappel date updated (18017)
* Expiry date updated (18018)
* Scan ticket (18019)
* Add products (18020)
* Remove products (18021)
* Payment request created (18022)
* Payment request confirmed (18023)
* Payment request cancelled (18024)
* Remove payment (18025)
* Mail not delivered (18026)
* Split order (18027)
* Tickets/documents downloaded (18028)
* Tickets/documents downloaded via API (18029)
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/LogItem).
type LogicalPlan ¶ added in v1.0.30
type LogicalPlan struct {
// The ID of the zone
Id int64 `json:"id"`
// The name of the zone
Name string `json:"name"`
// The rows layout
Rows []*LogicalPlanRow `json:"rows"`
}
The logical plan describes the structure and layout of seats in a zone.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/LogicalPlan).
type LogicalPlanRow ¶ added in v1.0.31
type LogicalPlanRow struct {
// The name of the row
Name string `json:"name"`
// The coordinate of the row
Coord int64 `json:"coord"`
// The seats in this row
Seats []*LogicalPlanSeat `json:"seats"`
}
A row contains a set of seats
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/LogicalPlanRow).
type LogicalPlanSeat ¶ added in v1.0.31
type LogicalPlanSeat struct {
// The ID of the seat
Id string `json:"id"`
// The name of the seat
Name string `json:"name"`
// The center point [x,y] of the seat
Center []float64 `json:"center"`
// The coordinate of the seat
Coord int64 `json:"coord"`
// Should this seat be sold prior to other seats
Priority int64 `json:"priority"`
// The rowname of the seat
Rowname string `json:"rowname"`
// The seat description template for this seat
Seatdescriptionid int64 `json:"seatdescriptionid,omitempty"`
// The seat rank for this seat
Seatrankid int64 `json:"seatrankid"`
// The width and height of the seat
Size []float64 `json:"size"`
}
The definition of a seat.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/LogicalPlanSeat).
type OptIn ¶ added in v1.0.83
type OptIn struct {
// Unique ID
//
// Note: Ignored when creating a new opt in.
//
// Note: Ignored when updating an existing opt in.
Id int64 `json:"id"`
// Type of the opt-in. Can be 'Mandatory' (40001) or 'Optional' (40002)
Typeid int64 `json:"typeid"`
// Name
Name string `json:"name"`
// Sales channel where this opt-in is available
Availability []*OptInAvailability `json:"availability"`
// Caption for the checkbox, needs to be set when typeid is Optional (40002)
Caption string `json:"caption"`
// Description
Description string `json:"description"`
// Caption for no radio button, needs to be set when typeid is Mandatory (40001)
Nocaption string `json:"nocaption"`
// Caption for yes radio button, needs to be set when typeid is Mandatory (40001)
Yescaption string `json:"yescaption"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new opt in.
//
// Note: Ignored when updating an existing opt in.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new opt in.
//
// Note: Ignored when updating an existing opt in.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new opt in.
//
// Note: Ignored when updating an existing opt in.
Lastupdatets Time `json:"lastupdatets"`
}
A single opt in.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/optins/get) and the opt ins endpoint (https://www.ticketmatic.com/docs/api/settings/system/optins).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OptIn).
type OptInAvailability ¶ added in v1.0.82
type OptInAvailability struct {
// Sales channel ID
Saleschannelid int64 `json:"saleschannelid"`
}
The opt-in will be available for this saleschannel.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OptInAvailability).
type OptInQuery ¶ added in v1.0.83
type OptInQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter opt ins.
More info: see opt in (https://www.ticketmatic.com/docs/api/types/OptIn), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/optins/getlist) and the opt ins endpoint (https://www.ticketmatic.com/docs/api/settings/system/optins).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OptInQuery).
type Order ¶
type Order struct {
// Order ID
Orderid int64 `json:"orderid,omitempty"`
// Total amount paid
//
// Note: Ignored when importing orders.
Amountpaid float64 `json:"amountpaid"`
// Whether or not auto / script order fees should be calculated
//
// Note: Ignored when importing orders.
CalculateOrdercosts bool `json:"calculate_ordercosts"`
// Order code
//
// Used as a unique identifier in web sales.
Code string `json:"code,omitempty"`
// Customer ID
Customerid int64 `json:"customerid"`
// Information on the deferred payment scenario. Structure depends on payment
// method
//
// Note: Ignored when importing orders.
Deferredpaymentproperties map[string]interface{} `json:"deferredpaymentproperties,omitempty"`
// Address used when delivering physically
Deliveryaddress *Address `json:"deliveryaddress,omitempty"`
// Delivery scenario ID
//
// See delivery scenarios
// (https://www.ticketmatic.com/docs/api/settings/ticketsales/deliveryscenarios)
// for more info.
Deliveryscenarioid int64 `json:"deliveryscenarioid,omitempty"`
// Delivery status
//
// Possible values:
//
// * 2601: Not delivered
//
// * 2602: Delivered
//
// * 2603: Changed after delivery
Deliverystatus int64 `json:"deliverystatus"`
// Whether the expired order has been handled (and optionally expiry mail has been
// sent)
Expiryhandled bool `json:"expiryhandled"`
// When the order will expire
Expiryts Time `json:"expiryts"`
// First name (only with minimal output)
Firstname string `json:"firstname,omitempty"`
// Indicates of the order has an open payment request with a PSP.
//
// Note: Ignored when importing orders.
Hasopenpaymentrequest bool `json:"hasopenpaymentrequest,omitempty"`
// Has customer authenticated?
//
// Note: Ignored when importing orders.
Isauthenticatedcustomer bool `json:"isauthenticatedcustomer"`
// Last name (only with minimal output)
Lastname string `json:"lastname,omitempty"`
// Related objects
//
// See the lookup fields on the getlist operation
// (https://www.ticketmatic.com/docs/api/orders/getlist) for a full description.
//
// Note: Ignored when importing orders.
Lookup map[string]interface{} `json:"lookup,omitempty"`
// Number of tickets in the order. Read-only
//
// Note: Ignored when importing orders.
Nbroftickets int64 `json:"nbroftickets"`
// Order fees for the order
Ordercosts []*Ordercost `json:"ordercosts"`
// Payments for the order
Payments []*Payment `json:"payments"`
// Payment scenario ID
//
// See payment scenarios
// (https://www.ticketmatic.com/docs/api/settings/ticketsales/paymentscenarios) for
// more info.
Paymentscenarioid int64 `json:"paymentscenarioid,omitempty"`
// Payment status
//
// Possible values:
//
// * 0: Incomplete
//
// * 1: Fully paid
//
// * 2: Overpaid
//
// Note: Ignored when importing orders.
Paymentstatus int64 `json:"paymentstatus"`
// Products in the order
Products []*OrderProduct `json:"products"`
// Promocodes active for the Order
//
// Note: Ignored when importing orders.
Promocodes []string `json:"promocodes"`
// Queue tokens for rate limiting
//
// Note: Ignored when importing orders.
Queuetokens []int64 `json:"queuetokens"`
// Whether the overdue order has been handled (and optionally reminder mail has
// been sent)
Rappelhandled bool `json:"rappelhandled"`
// When the reminder mail will be sent
Rappelts Time `json:"rappelts"`
// Sales channel ID
//
// See sales channels
// (https://www.ticketmatic.com/docs/api/settings/ticketsales/saleschannels) for
// more info.
Saleschannelid int64 `json:"saleschannelid"`
// Order status
//
// Possible values:
//
// * 21001: Unconfirmed
//
// * 21002: Confirmed
//
// * 21003: Archived
//
// Note: Ignored when importing orders.
Status int64 `json:"status"`
// Tickets in the order
Tickets []*OrderTicket `json:"tickets"`
// Total order amount
//
// Includes all costs and fees.
//
// Note: Ignored when importing orders.
Totalamount float64 `json:"totalamount"`
// Reference to the webskin that is used for showing the orderdetail page.
//
// Note: Ignored when importing orders.
Webskinid int64 `json:"webskinid"`
// Created timestamp
Createdts Time `json:"createdts,omitempty"`
// Last updated timestamp
Lastupdatets Time `json:"lastupdatets,omitempty"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A single Order.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Order).
func (*Order) MarshalJSON ¶
Custom marshaller with support for custom fields
func (*Order) UnmarshalJSON ¶
Custom unmarshaller with support for custom fields
type OrderFee ¶
type OrderFee struct {
// Unique ID
//
// Note: Ignored when creating a new order fee definition.
//
// Note: Ignored when creating a new order fee.
Id int64 `json:"id"`
// Type of the order fee. Can be Automatic (2401), Script (2402) or Manual (2403)
Typeid int64 `json:"typeid"`
// Name for the order fee
Name string `json:"name"`
// Definition of the rule that defines when the order fee will be applied
//
// Note: Not set when retrieving a list of order fee definitions.
//
// Note: Not set when retrieving a list of order fees.
Rule *OrderfeeRule `json:"rule,omitempty"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new order fee definition.
//
// Note: Ignored when creating a new order fee.
Isarchived bool `json:"isarchived"`
// Archived timestamp
//
// Note: Ignored when creating a new order fee definition.
//
// Note: Ignored when creating a new order fee.
Archivedts Time `json:"archivedts"`
// Created timestamp
//
// Note: Ignored when creating a new order fee definition.
//
// Note: Ignored when creating a new order fee.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new order fee definition.
//
// Note: Ignored when creating a new order fee.
Lastupdatets Time `json:"lastupdatets"`
}
A single order fee.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/ticketsales/orderfees/get) and the order fees endpoint (https://www.ticketmatic.com/docs/api/settings/ticketsales/orderfees).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderFee).
type OrderFeeDefinition ¶
type OrderFeeDefinition struct {
// Unique ID
//
// Note: Ignored when creating a new order fee definition.
//
// Note: Ignored when creating a new order fee.
Id int64 `json:"id"`
// Type of the order fee. Can be Automatic (2401), Script (2402) or Manual (2403)
Typeid int64 `json:"typeid"`
// Name for the order fee
Name string `json:"name"`
// Definition of the rule that defines when the order fee will be applied
//
// Note: Not set when retrieving a list of order fee definitions.
//
// Note: Not set when retrieving a list of order fees.
Rule *OrderfeeRule `json:"rule,omitempty"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new order fee definition.
//
// Note: Ignored when creating a new order fee.
Isarchived bool `json:"isarchived"`
// Archived timestamp
//
// Note: Ignored when creating a new order fee definition.
//
// Note: Ignored when creating a new order fee.
Archivedts Time `json:"archivedts"`
// Created timestamp
//
// Note: Ignored when creating a new order fee definition.
//
// Note: Ignored when creating a new order fee.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new order fee definition.
//
// Note: Ignored when creating a new order fee.
Lastupdatets Time `json:"lastupdatets"`
}
A single order fee definition.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/pricing/orderfeedefinitions/get) and the order fee definitions endpoint (https://www.ticketmatic.com/docs/api/settings/pricing/orderfeedefinitions).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderFeeDefinition).
type OrderFeeDefinitionQuery ¶
type OrderFeeDefinitionQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter order fee definitions.
More info: see order fee definition (https://www.ticketmatic.com/docs/api/types/OrderFeeDefinition), the getlist operation (https://www.ticketmatic.com/docs/api/settings/pricing/orderfeedefinitions/getlist) and the order fee definitions endpoint (https://www.ticketmatic.com/docs/api/settings/pricing/orderfeedefinitions).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderFeeDefinitionQuery).
type OrderFeeQuery ¶
type OrderFeeQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter order fees.
More info: see order fee (https://www.ticketmatic.com/docs/api/types/OrderFee), the getlist operation (https://www.ticketmatic.com/docs/api/settings/ticketsales/orderfees/getlist) and the order fees endpoint (https://www.ticketmatic.com/docs/api/settings/ticketsales/orderfees).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderFeeQuery).
type OrderFilter ¶
type OrderFilter struct {
// Only include orders older than the given timestamp
Createdsince Time `json:"createdsince,omitempty"`
// Filter orders based on customer
Customerid int64 `json:"customerid,omitempty"`
// Filter orders based on saleschannel
Saleschannelid int64 `json:"saleschannelid,omitempty"`
// Only include orders with a given status
//
// Possible values:
//
// * 21001: Unconfirmed orders
//
// * 21002: Confirmed orders
//
// * 21003: Archived orders
Status int64 `json:"status,omitempty"`
}
Used when requesting orders, to filter orders.
Specify any of the supported fields to filter the list of orders.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderFilter).
type OrderIdReservation ¶
type OrderIdReservation struct {
// Maximum ID to reserve
Id int64 `json:"id"`
}
Order ID reservation
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderIdReservation).
type OrderImportStatus ¶
type OrderImportStatus struct {
// Order ID
Id int64 `json:"id"`
// Error message, if failed
Error string `json:"error"`
// Whether the import succeeded
Ok bool `json:"ok"`
}
Import status per order
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderImportStatus).
type OrderMailTemplate ¶
type OrderMailTemplate struct {
// Unique ID
//
// Note: Ignored when creating a new order mail template.
//
// Note: Ignored when updating an existing order mail template.
Id int64 `json:"id"`
// The type of this order mail template, defines where this template is used. The
// available values for this field can be found on the order mail template overview
// (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ordermails)
// page.
Typeid int64 `json:"typeid"`
// Name of the order mail template
Name string `json:"name"`
// Message body
//
// Note: Not set when retrieving a list of order mail templates.
Body string `json:"body"`
// Subject line for the order mail template
//
// Note: Not set when retrieving a list of order mail templates.
Subject string `json:"subject"`
// A map of language codes to gettext .po files
// (http://en.wikipedia.org/wiki/Gettext). More info
// can be found on the order mail template overview
// (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ordermails)
// page.
//
// Note: Not set when retrieving a list of order mail templates.
Translations map[string]string `json:"translations,omitempty"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new order mail template.
//
// Note: Ignored when updating an existing order mail template.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new order mail template.
//
// Note: Ignored when updating an existing order mail template.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new order mail template.
//
// Note: Ignored when updating an existing order mail template.
Lastupdatets Time `json:"lastupdatets"`
}
A single order mail template.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ordermails/get) and the order mail templates endpoint (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ordermails).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderMailTemplate).
type OrderMailTemplateQuery ¶
type OrderMailTemplateQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter order mail templates.
More info: see order mail template (https://www.ticketmatic.com/docs/api/types/OrderMailTemplate), the getlist operation (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ordermails/getlist) and the order mail templates endpoint (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ordermails).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderMailTemplateQuery).
type OrderProduct ¶
type OrderProduct struct {
// Orderproduct ID
Id int64 `json:"id"`
// Order ID
Orderid int64 `json:"orderid"`
// Unique code for this orderproduct
Code string `json:"code"`
// Contact ID: the holder of this product
Contactid int64 `json:"contactid"`
// Ticket price
Price float64 `json:"price"`
// Product ID
Productid int64 `json:"productid"`
// Property values for this product
Properties map[string]string `json:"properties,omitempty"`
// Vouchercode ID for the voucher that is linked to this orderproduct
Vouchercodeid int64 `json:"vouchercodeid"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A single product in an order.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderProduct).
func (*OrderProduct) MarshalJSON ¶ added in v1.0.105
func (o *OrderProduct) MarshalJSON() ([]byte, error)
Custom marshaller with support for custom fields
func (*OrderProduct) UnmarshalJSON ¶ added in v1.0.105
func (o *OrderProduct) UnmarshalJSON(data []byte) error
Custom unmarshaller with support for custom fields
type OrderQuery ¶
type OrderQuery struct {
// A SQL query that returns order IDs
//
// Can be used to do arbitrary filtering. See the database documentation for order
// (https://www.ticketmatic.com/docs/db/order) for more information.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// Only include orders that have been updated since the given timestamp.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
// Limit results to at most the given amount of orders.
Limit int64 `json:"limit,omitempty"`
// Skip the first X orders.
Offset int64 `json:"offset,omitempty"`
// Order by the given field.
//
// Supported values: createdts, lastupdatets.
Orderby string `json:"orderby,omitempty"`
// Sets the direction for ordering. Default false.
OrderbyAsc bool `json:"orderby_asc,omitempty"`
// Output format.
//
// Possible values:
//
// * ids: Only fill the ID field
//
// * minimal: A minimal set of order fields
//
// * default: Return all order fields (also used when the output parameter is
// omitted)
//
// * withlookup: Returns all order fields and an additional lookup field which
// contains all dependent objects
Output string `json:"output,omitempty"`
// A text filter string.
//
// Matches against the order ID or the customer details..
Searchterm string `json:"searchterm,omitempty"`
// Filters the orders based on a given set of fields. Currently supports:
// createdsince, saleschannelid, customerid, status.
Simplefilter *OrderFilter `json:"simplefilter,omitempty"`
}
Filter parameters to fetch a list of orders
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderQuery).
type OrderTicket ¶
type OrderTicket struct {
// Ticket ID
Id int64 `json:"id"`
// Order ID
Orderid int64 `json:"orderid"`
// The barcode of this ticket, will be visible when the order is confirmed
Barcode string `json:"barcode"`
// The id of the product this ticket is linked to
Bundleid int64 `json:"bundleid"`
// The key of the fixedseat variant this ticket is linked to
Bundlevariant string `json:"bundlevariant"`
// Accesscontrol status for this ticket
Cachedaccesscontrolstatus int64 `json:"cachedaccesscontrolstatus"`
// The timestamp of the last delivery of this ticket
Deliveredts Time `json:"deliveredts"`
// Event id
Eventid int64 `json:"eventid"`
// Ticket price
Price float64 `json:"price"`
// Pricetype id
Pricetypeid int64 `json:"pricetypeid"`
// Seat coordinate - x
Seatcachedvisualx float64 `json:"seatcachedvisualx"`
// Seat coordinate - y
Seatcachedvisualy float64 `json:"seatcachedvisualy"`
// Description of the ticket
Seatdescription string `json:"seatdescription"`
// Seated ref
SeatedRef string `json:"seated_ref"`
// Name of the seat
Seatname string `json:"seatname"`
// Seatzone ID
Seatzoneid int64 `json:"seatzoneid"`
// Service charge
Servicecharge float64 `json:"servicecharge"`
// Ticket holder ID
Ticketholderid int64 `json:"ticketholderid"`
// Name for the ticket holder
Ticketname string `json:"ticketname"`
// Contingent ID
Tickettypeid int64 `json:"tickettypeid"`
// Contingent name
Tickettypename string `json:"tickettypename"`
// Id for the tickettypeprice of this ticket for the order
Tickettypepriceid int64 `json:"tickettypepriceid"`
// The contact this ticket is transferred to
Transferredto int64 `json:"transferredto"`
// The voucher code that was linked to this ticket
Vouchercodeid int64 `json:"vouchercodeid"`
}
A single ticket in an order.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderTicket).
type OrderTickettype ¶
type OrderTickettype struct {
// Tickettype id
Id int64 `json:"id"`
// Tickettype name
Name string `json:"name"`
// Tickettype full name
Fulltypename string `json:"fulltypename"`
}
Order tickettype
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderTickettype).
type Ordercost ¶
type Ordercost struct {
// Order ID
Orderid int64 `json:"orderid"`
// Payment amount
Amount float64 `json:"amount"`
// Order fee ID
Servicechargedefinitionid int64 `json:"servicechargedefinitionid"`
}
A single order fee for an order.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Ordercost).
type OrderfeeAutoRule ¶
type OrderfeeAutoRule struct {
// The delivery scenarios that this order fee is applicable for. If not set
// it defaults to 'all'. This is only needed if the order fee type is set to
// automatic.
Deliveryscenarioids []int64 `json:"deliveryscenarioids"`
// The payment scenarios that this order fee is applicable for. If not set it
// default to 'all'. This is only needed if the order fee type is set to automatic.
Paymentscenarioids []int64 `json:"paymentscenarioids"`
// The sales channels that this order fee is applicable for. If not set it defaults
// to 'all'. This is only needed if the order fee type is set to automatic.
Saleschannelids []int64 `json:"saleschannelids"`
// Can be fixedfee or percentagefee. Defauls to fixedfee. This is only needed if
// the order fee type is set to automatic.
Status string `json:"status,omitempty"`
// The value (amount) that will be added to the order. Is required if the order fee
// type is set to automatic.
Value float64 `json:"value,omitempty"`
}
More info about order fees can be found here (https://www.ticketmatic.com/docs/api/settings/ticketsales/orderfees).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderfeeAutoRule).
type OrderfeeRule ¶
type OrderfeeRule struct {
// This is required if the order fee type is set to automatic. It is a set of rules
// that define the order fee.
Auto []*OrderfeeAutoRule `json:"auto"`
// This can be set if the order fee type is set to script. It allows adding extra
// information to the script environment.
Context []*OrderfeeScriptContext `json:"context"`
// This is required if the order fee type is set to script. The javascript needs to
// return a value.
Script string `json:"script,omitempty"`
}
More info about order fees can be found here (https://www.ticketmatic.com/docs/api/settings/ticketsales/orderfees).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderfeeRule).
type OrderfeeScriptContext ¶
type OrderfeeScriptContext struct {
// If set to true the query will be cached for 60 seconds. If not set the query
// will be executed again every time a script is executed.
Cacheable bool `json:"cacheable,omitempty"`
// The name of the variable that will be added to the script environment.
Key string `json:"key"`
// The query that will be executed on the public data model. The result will be
// available in the script environment.
Query string `json:"query"`
}
More info about order fees can be found here (https://www.ticketmatic.com/docs/api/settings/ticketsales/orderfees).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/OrderfeeScriptContext).
type Payment ¶
type Payment struct {
// Payment ID
Id int64 `json:"id"`
// Order ID
Orderid int64 `json:"orderid"`
// Payment amount
Amount float64 `json:"amount"`
// Timestamp of payment
Paidts Time `json:"paidts"`
// Payment method ID
Paymentmethodid int64 `json:"paymentmethodid"`
// Additional properties for the payment. Structure depends on the payment method
Properties map[string]interface{} `json:"properties,omitempty"`
// Id for the original payment if this payment is a refund
Refundpaymentid int64 `json:"refundpaymentid"`
// Id of the vouchercode to use for this payment
//
// Note: Ignored when importing orders.
Vouchercodeid int64 `json:"vouchercodeid"`
}
A single payment.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Payment).
type PaymentMethod ¶
type PaymentMethod struct {
// Unique ID
//
// Note: Ignored when creating a new payment method.
//
// Note: Ignored when updating an existing payment method.
Id int64 `json:"id"`
// Name of the payment method
Name string `json:"name"`
// Specific configuration for the payment method, content depends on the payment
// method type.
//
// Note: Not set when retrieving a list of payment methods.
Config map[string]interface{} `json:"config,omitempty"`
// Internal remark, will not be shown to customers
Internalremark string `json:"internalremark"`
// Type of the paymentmethod. For a list of possible types see here
// (https://www.ticketmatic.com/docs/api/settings/ticketsales/paymentmethods)
Paymentmethodtypeid int64 `json:"paymentmethodtypeid"`
// Payment Service Provider this payment method is linked to
Pspid int64 `json:"pspid"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new payment method.
//
// Note: Ignored when updating an existing payment method.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new payment method.
//
// Note: Ignored when updating an existing payment method.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new payment method.
//
// Note: Ignored when updating an existing payment method.
Lastupdatets Time `json:"lastupdatets"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A single payment method.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/ticketsales/paymentmethods/get) and the payment methods endpoint (https://www.ticketmatic.com/docs/api/settings/ticketsales/paymentmethods).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PaymentMethod).
func (*PaymentMethod) MarshalJSON ¶ added in v1.0.74
func (o *PaymentMethod) MarshalJSON() ([]byte, error)
Custom marshaller with support for custom fields
func (*PaymentMethod) UnmarshalJSON ¶ added in v1.0.74
func (o *PaymentMethod) UnmarshalJSON(data []byte) error
Custom unmarshaller with support for custom fields
type PaymentMethodQuery ¶
type PaymentMethodQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter payment methods.
More info: see payment method (https://www.ticketmatic.com/docs/api/types/PaymentMethod), the getlist operation (https://www.ticketmatic.com/docs/api/settings/ticketsales/paymentmethods/getlist) and the payment methods endpoint (https://www.ticketmatic.com/docs/api/settings/ticketsales/paymentmethods).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PaymentMethodQuery).
type PaymentRequest ¶
type PaymentRequest struct {
// The language to be used during the payment processing
Language string `json:"language"`
// The returnurl that will be called after the payment request was done.
Returnurl string `json:"returnurl"`
// Create (or use an existing) customer with the PSP. The order needs a linked
// contact.
Withcustomer bool `json:"withcustomer"`
}
Info for requesting an immediate payment in an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PaymentRequest).
type PaymentScenario ¶
type PaymentScenario struct {
// Unique ID
//
// Note: Ignored when creating a new payment scenario.
//
// Note: Ignored when updating an existing payment scenario.
Id int64 `json:"id"`
// Type for the payment scenario. Can be 'Immediate payment' (2701), 'Mollie bank
// transfer' (2702), 'Regular bank transfer' (2703), 'Deferred online payment'
// (2704), 'Deferred other' (2705).
Typeid int64 `json:"typeid"`
// Name of the payment scenario
Name string `json:"name"`
// Rules that define in what conditions this payment scenario is available
//
// Note: Not set when retrieving a list of payment scenarios.
Availability *PaymentscenarioAvailability `json:"availability,omitempty"`
// Beneficiary for the bank account number. Only used for type 2703 (Regular bank
// transfer)
Bankaccountbeneficiary string `json:"bankaccountbeneficiary,omitempty"`
// BIC code for the bank account number. Only used for type 2703 (Regular bank
// transfer)
Bankaccountbic string `json:"bankaccountbic,omitempty"`
// Bank account number to be used. Only used for type 2703 (Regular bank transfer)
Bankaccountnumber string `json:"bankaccountnumber,omitempty"`
// Rules that define when an order becomes expired. Not used for type 2701.
//
// Note: Not set when retrieving a list of payment scenarios.
Expiryparameters *PaymentscenarioExpiryParameters `json:"expiryparameters,omitempty"`
// A very short description of the fee that is applicable.
Feedescription string `json:"feedescription"`
// An internal remark, which is never shown to customers. Can be used to
// distinguish identically named payment scenarios.
//
// For example: You could have two VISA scenarios, one for the web sales and one
// for the box office, each will have different fee configurations. Both will be
// named VISA, this field can be used to distinguish them.
Internalremark string `json:"internalremark,omitempty"`
// Logo url
Logo string `json:"logo"`
// Send mail to organization if known
Mailorganization bool `json:"mailorganization"`
// Link to the order mail template that will be sent when the order is expired.
// Can be 0 to indicate that no mail should be sent. Not used for type 2701.
OrdermailtemplateidExpiry int64 `json:"ordermailtemplateid_expiry"`
// Link to the order mail template that will be sent when the order is overdue.
// Can be 0 to indicate that no mail should be sent. Not used for type 2701.
OrdermailtemplateidOverdue int64 `json:"ordermailtemplateid_overdue"`
// Link to the order mail template that will be sent as payment instruction.
// Can be 0 to indicate that no mail should be sent. Not used for type 2701.
OrdermailtemplateidPaymentinstruction int64 `json:"ordermailtemplateid_paymentinstruction"`
// Rules that define when an order becomes overdue. Not used for type 2701.
//
// Note: Not set when retrieving a list of payment scenarios.
Overdueparameters *PaymentscenarioOverdueParameters `json:"overdueparameters,omitempty"`
// Set of payment methods that are linked to this payment scenario. Depending on
// the type, this field has different usage.
Paymentmethods []int64 `json:"paymentmethods"`
// Short description of the payment scenario, will be shown to customers
Shortdescription string `json:"shortdescription,omitempty"`
// Parameter that sets the visibility of this scenario, can be either 'FULL' or
// 'API'.
Visibility string `json:"visibility"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new payment scenario.
//
// Note: Ignored when updating an existing payment scenario.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new payment scenario.
//
// Note: Ignored when updating an existing payment scenario.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new payment scenario.
//
// Note: Ignored when updating an existing payment scenario.
Lastupdatets Time `json:"lastupdatets"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A single payment scenario.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/ticketsales/paymentscenarios/get) and the payment scenarios endpoint (https://www.ticketmatic.com/docs/api/settings/ticketsales/paymentscenarios).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PaymentScenario).
func (*PaymentScenario) MarshalJSON ¶ added in v1.0.75
func (o *PaymentScenario) MarshalJSON() ([]byte, error)
Custom marshaller with support for custom fields
func (*PaymentScenario) UnmarshalJSON ¶ added in v1.0.75
func (o *PaymentScenario) UnmarshalJSON(data []byte) error
Custom unmarshaller with support for custom fields
type PaymentScenarioQuery ¶
type PaymentScenarioQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter payment scenarios.
More info: see payment scenario (https://www.ticketmatic.com/docs/api/types/PaymentScenario), the getlist operation (https://www.ticketmatic.com/docs/api/settings/ticketsales/paymentscenarios/getlist) and the payment scenarios endpoint (https://www.ticketmatic.com/docs/api/settings/ticketsales/paymentscenarios).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PaymentScenarioQuery).
type PaymentscenarioAvailability ¶
type PaymentscenarioAvailability struct {
// The payment scenario will be available for these saleschannels. It this is empty
// the payment scenario will not be available.
Saleschannels []int64 `json:"saleschannels"`
// A Javascript that needs to return a boolean. It has
// the current order and saleschannel available. More info
// (https://www.ticketmatic.com/docs/tickets/configure_ticket_sales/orderfees)
Script string `json:"script"`
// Indicates if the script will be used.
Usescript bool `json:"usescript"`
}
A PaymentscenarioAvailability configures in what saleschannels a payment scenario is available.
It can also further refine the availability based on a script written in JavaScript.
More information about writing order scripts can be found here (https://www.ticketmatic.com/docs/tickets/configure_ticket_sales/orderfees).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PaymentscenarioAvailability).
type PaymentscenarioExpiryParameters ¶
type PaymentscenarioExpiryParameters struct {
// The amount of days after the paymentscenario was set that the order becomes
// overdue.
Daysaftercreation int64 `json:"daysaftercreation"`
// DEPRECATED, use daysaftercreation. The amount of days after an order has been
// created that the order becomes overdue.
Daysafterordercreation int64 `json:"daysafterordercreation"`
// DEPRECATED, use daysaftercreation. The number of days before an event that an
// order becomes overdue.
Daysbeforeevent int64 `json:"daysbeforeevent"`
// Indicates is the order will be deleted when it's expired.
Deleteonexpiry bool `json:"deleteonexpiry"`
}
The PaymentscenarioExpiryParameters can only be set when the Paymentscenario is of a type deferred payment.
It determines the moment in time when an order expires. It's calculated as MIN(<order creation date> + daysafterordercreation, <date of first event in order> - daysbeforeevent). If deleteonexpiry is set to true, the order will be deleted.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PaymentscenarioExpiryParameters).
type PaymentscenarioOverdueParameters ¶
type PaymentscenarioOverdueParameters struct {
// The amount of days after the paymentscenario was set that the order becomes
// overdue.
Daysaftercreation int64 `json:"daysaftercreation"`
// DEPRECATED, use daysaftercreation. The amount of days after an order has been
// created that the order becomes overdue.
Daysafterordercreation int64 `json:"daysafterordercreation"`
// DEPRECATED, use daysaftercreation. The number of days before an event that an
// order becomes overdue.
Daysbeforeevent int64 `json:"daysbeforeevent"`
}
The PaymentscenarioOverdueParameters can only be set when the Paymentscenario is of type deferred payment.
It determines the moment in time when an order becomes overdue. It's calculated as MIN(<order creation date> + daysafterordercreation, <date of first event in order> - daysbeforeevent).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PaymentscenarioOverdueParameters).
type PhoneNumberType ¶
type PhoneNumberType struct {
// Unique ID
//
// Note: Ignored when creating a new phone number type.
//
// Note: Ignored when updating an existing phone number type.
Id int64 `json:"id"`
// Name of the phone number type
Name string `json:"name"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new phone number type.
//
// Note: Ignored when updating an existing phone number type.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new phone number type.
//
// Note: Ignored when updating an existing phone number type.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new phone number type.
//
// Note: Ignored when updating an existing phone number type.
Lastupdatets Time `json:"lastupdatets"`
}
A single phone number type.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/phonenumbertypes/get) and the phone number types endpoint (https://www.ticketmatic.com/docs/api/settings/system/phonenumbertypes).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PhoneNumberType).
type PhoneNumberTypeQuery ¶
type PhoneNumberTypeQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter phone number types.
More info: see phone number type (https://www.ticketmatic.com/docs/api/types/PhoneNumberType), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/phonenumbertypes/getlist) and the phone number types endpoint (https://www.ticketmatic.com/docs/api/settings/system/phonenumbertypes).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PhoneNumberTypeQuery).
type Phonenumber ¶
type Phonenumber struct {
// Phone number ID
Id int64 `json:"id"`
// Phone number type ID
Typeid int64 `json:"typeid"`
// Contact this address belongs to
Customerid int64 `json:"customerid"`
// Phone number
Number string `json:"number"`
// Phone number type (based on typeid, returned as a convenience)
Type string `json:"type"`
}
See contact (https://www.ticketmatic.com/docs/api/types/Contact) for more information.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Phonenumber).
type PriceList ¶
type PriceList struct {
// Unique ID
//
// Note: Ignored when creating a new price list.
//
// Note: Ignored when updating an existing price list.
Id int64 `json:"id"`
// Name for the pricelist
Name string `json:"name"`
// Boolean indicating whether this pricelist has ranks or not
Hasranks bool `json:"hasranks"`
// Definition of the actual prices and conditions for the pricelist
//
// Note: Not set when retrieving a list of price lists.
Prices *PricelistPrices `json:"prices,omitempty"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new price list.
//
// Note: Ignored when updating an existing price list.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new price list.
//
// Note: Ignored when updating an existing price list.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new price list.
//
// Note: Ignored when updating an existing price list.
Lastupdatets Time `json:"lastupdatets"`
}
A single price list.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/pricing/pricelists/get) and the price lists endpoint (https://www.ticketmatic.com/docs/api/settings/pricing/pricelists).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PriceList).
type PriceListQuery ¶
type PriceListQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter price lists.
More info: see price list (https://www.ticketmatic.com/docs/api/types/PriceList), the getlist operation (https://www.ticketmatic.com/docs/api/settings/pricing/pricelists/getlist) and the price lists endpoint (https://www.ticketmatic.com/docs/api/settings/pricing/pricelists).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PriceListQuery).
type PriceType ¶
type PriceType struct {
// Unique ID
//
// Note: Ignored when creating a new price type.
//
// Note: Ignored when updating an existing price type.
Id int64 `json:"id"`
// The category of this price type, defines how the price is displayed.
// The available values for this field can be found on the price type overview
// (https://www.ticketmatic.com/docs/api/settings/pricing/pricetypes) page.
Typeid int64 `json:"typeid"`
// Name of the price type
Name string `json:"name"`
// A remark that describes the price type. Will be shown to customers.
Remark string `json:"remark"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new price type.
//
// Note: Ignored when updating an existing price type.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new price type.
//
// Note: Ignored when updating an existing price type.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new price type.
//
// Note: Ignored when updating an existing price type.
Lastupdatets Time `json:"lastupdatets"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A single price type.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/pricing/pricetypes/get) and the price types endpoint (https://www.ticketmatic.com/docs/api/settings/pricing/pricetypes).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PriceType).
func (*PriceType) MarshalJSON ¶ added in v1.0.74
Custom marshaller with support for custom fields
func (*PriceType) UnmarshalJSON ¶ added in v1.0.74
Custom unmarshaller with support for custom fields
type PriceTypeQuery ¶
type PriceTypeQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter price types.
More info: see price type (https://www.ticketmatic.com/docs/api/types/PriceType), the getlist operation (https://www.ticketmatic.com/docs/api/settings/pricing/pricetypes/getlist) and the price types endpoint (https://www.ticketmatic.com/docs/api/settings/pricing/pricetypes).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PriceTypeQuery).
type PricelistPrice ¶
type PricelistPrice struct {
// Array of booleans indicating if the corresponding price is available for this
// PricelistPrice. Should contain the same number of booleans as prices.
Availabilities []bool `json:"availabilities"`
// Extra conditions for this price. This can be a promocode, a ticketlimit per
// order, ... .
Conditions []*PricelistPriceCondition `json:"conditions"`
// Optional, and only used for eventspecificprices. Indicates the position of this
// price in the pricelist.
Position int64 `json:"position"`
// The (decimal) prices for this PricelistPrice. If no seatrankids has been set,
// this should consist of 1 price. If seatrankids are set this should an equal
// number of prices as the number of seatranks.
Prices []float64 `json:"prices"`
// The pricetype for this price.
Pricetypeid int64 `json:"pricetypeid"`
// The list of saleschannels for which this PricelistPrice is active.
Saleschannels []int64 `json:"saleschannels"`
}
You can find more information about price in the endpoint documentation (https://www.ticketmatic.com/docs/api/settings/pricing/pricelists).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PricelistPrice).
type PricelistPriceCondition ¶
type PricelistPriceCondition struct {
// The type of condition. Possible values:
//
// * ticketlimit
//
// * date
//
// * promocode
//
// * orderticketlimit
//
// * voucherids
Type string `json:"type"`
// The value of this condition. See type for info about what should be filled in.
Value interface{} `json:"value,omitempty"`
}
These are the possible condition and example values:
Ticketlimit ¶
There is a limited amount of tickets available for the selected pricetype.
{
"type": "ticketlimit",
"value": 10
}
Date validity ¶
The price type is only available in this period.
Absolute ¶
{
"type": "date",
"value": {
"datetype": "absolute",
"absoluteStart": "2015-05-20",
"absoluteEnd": "2015-05-27"
}
}
Relative ¶
{
"type": "date",
"value": {
"datetype": "relative_eventdate",
"relativeStart": 10,
"relativeEnd": 5
}
}
Promocode ¶
The price type is only available if the customer provides a promocode.
{
"type": "promocode",
"value": ["TM"]
}
Max number of tickets per customer ¶
Limit the maximum number of tickets a customer can buy of this specific price type.
{
"type": "orderticketlimit",
"value": 2
}
Voucherids ¶
When buying a ticket of this pricetype, a valid vouchercode with voucherid one of the values should be attached to the ticket.
{
"type": "voucherids",
"value": [1,2,3]
}
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PricelistPriceCondition).
type PricelistPrices ¶
type PricelistPrices struct {
// The set of prices for this pricelist.
Prices []*PricelistPrice `json:"prices"`
// The seatranks for which this pricelist lists prices.
Seatrankids []int64 `json:"seatrankids"`
}
You can find more information about prices in the endpoint documentation (https://www.ticketmatic.com/docs/api/settings/pricing/pricelists).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PricelistPrices).
type Product ¶
type Product struct {
// Unique ID
//
// Note: Ignored when creating a new product.
//
// Note: Ignored when updating an existing product.
Id int64 `json:"id"`
// Type ID
//
// Note: Ignored when updating an existing product.
Typeid int64 `json:"typeid"`
// Category for the product. Categories can be managed in account parameters and
// indicate the labels for a single and multiple product and also what labels to
// use for the holders of the product. If not set, the UI will fallback to default
// labels.
Categoryid int64 `json:"categoryid,omitempty"`
// Optional layout for the product. If not specified, there will be no ticket
// generated for the product
Layoutid int64 `json:"layoutid,omitempty"`
// Name for the product
Name string `json:"name"`
// If true, subscriber info is requested for each bundle in websales.
Asksubscribers bool `json:"asksubscribers,omitempty"`
// Unique 12-digit for the product
Code string `json:"code,omitempty"`
// Description for the product
Description string `json:"description,omitempty"`
// The customfield that is used to group the option bundle in the UI (websales and
// backoffice)
//
// Note: Not set when retrieving a list of products.
Groupbycustomfield int64 `json:"groupbycustomfield,omitempty"`
// Reference to product image
//
// Note: Ignored when creating a new product.
//
// Note: Ignored when updating an existing product.
//
// Note: Not set when retrieving a list of products.
Image string `json:"image,omitempty"`
// Instancevalues control the price for a product and for non simple products it
// also controls the content of the product. All products should have a default
// instancevalue and a set of exceptions (if there are any). If no specific
// exception is found for the selected product, the default instancevalue is used.
Instancevalues *ProductInstancevalues `json:"instancevalues,omitempty"`
// The amount of individual tickets per event that can be purchased alongside this
// bundle.
//
// Note: Not set when retrieving a list of products.
Maxadditionaltickets int64 `json:"maxadditionaltickets,omitempty"`
// If true, tickets for items that belong to the product will be printed when
// printing the product.
Printtickets bool `json:"printtickets,omitempty"`
// Definition of possible properties for the product. A product can have one or
// more properties. Properties can be used to introduce variants of a product
// (sizes of a t-shirt for example).
Properties []*ProductProperty `json:"properties"`
// Queue ID
//
// See rate limiting (https://www.ticketmatic.com/docs/api/ratelimiting) for more
// info.
//
// Note: Not set when retrieving a list of products.
Queuetoken int64 `json:"queuetoken,omitempty"`
// End of sales
Saleendts Time `json:"saleendts,omitempty"`
// Sales is active for these saleschannels
//
// Note: Not set when retrieving a list of products.
Saleschannels []int64 `json:"saleschannels"`
// Start of sales
Salestartts Time `json:"salestartts,omitempty"`
// Sale status messages in use for this product
Salestatusmessagesid int64 `json:"salestatusmessagesid,omitempty"`
// Short description for the product
Shortdescription string `json:"shortdescription,omitempty"`
// Translations for the product properties
//
// Note: Not set when retrieving a list of products.
Translations map[string]string `json:"translations,omitempty"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new product.
//
// Note: Ignored when updating an existing product.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new product.
//
// Note: Ignored when updating an existing product.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new product.
//
// Note: Ignored when updating an existing product.
Lastupdatets Time `json:"lastupdatets"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A single product.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/products/get) and the products endpoint (https://www.ticketmatic.com/docs/api/settings/products).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Product).
func (*Product) MarshalJSON ¶ added in v1.0.74
Custom marshaller with support for custom fields
func (*Product) UnmarshalJSON ¶ added in v1.0.74
Custom unmarshaller with support for custom fields
type ProductCategory ¶
type ProductCategory struct {
// Unique ID
//
// Note: Ignored when creating a new product category.
//
// Note: Ignored when updating an existing product category.
Id int64 `json:"id"`
// Name for the product category
Name string `json:"name"`
// Name for the holder/owner of this product
Contactname string `json:"contactname"`
// Name for the holder/owner of this product in plural
Contactnameplural string `json:"contactnameplural"`
// Name for the product category in plural
Nameplural string `json:"nameplural"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new product category.
//
// Note: Ignored when updating an existing product category.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new product category.
//
// Note: Ignored when updating an existing product category.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new product category.
//
// Note: Ignored when updating an existing product category.
Lastupdatets Time `json:"lastupdatets"`
}
A single product category.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/productcategories/get) and the product categories endpoint (https://www.ticketmatic.com/docs/api/settings/productcategories).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ProductCategory).
type ProductCategoryQuery ¶
type ProductCategoryQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter product categories.
More info: see product category (https://www.ticketmatic.com/docs/api/types/ProductCategory), the getlist operation (https://www.ticketmatic.com/docs/api/settings/productcategories/getlist) and the product categories endpoint (https://www.ticketmatic.com/docs/api/settings/productcategories).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ProductCategoryQuery).
type ProductInstanceException ¶
type ProductInstanceException struct {
// Properties for which this exception is valid
Properties map[string][]string `json:"properties,omitempty"`
// Value for this exception
Value *ProductInstanceValue `json:"value,omitempty"`
}
Product instancevalue exception
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ProductInstanceException).
type ProductInstancePricetypeValue ¶
type ProductInstancePricetypeValue struct {
// Pricetype id
Id int64 `json:"id"`
// Min amount from which the pricetype will be applied
From int64 `json:"from"`
}
Product Instance Pricetype Value
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ProductInstancePricetypeValue).
type ProductInstanceValue ¶
type ProductInstanceValue struct {
// Maximum price for a variable payment voucher
MaxPrice float64 `json:"max_price"`
// Minimum price for a variable payment voucher
MinPrice float64 `json:"min_price"`
// Price
Price float64 `json:"price"`
// Set of pricetype values (used in optionbundle products)
Pricetypes []*ProductInstancePricetypeValue `json:"pricetypes"`
// Set of tickettypeprices (used in fixedbundle products)
Tickettypeprices []int64 `json:"tickettypeprices"`
// Set of tickettypes (used in optionbundle products)
Tickettypes []int64 `json:"tickettypes"`
// Voucher
Voucher *ProductVoucherValue `json:"voucher,omitempty"`
}
Product instance value, used with products. It configures the price and the content of a product.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ProductInstanceValue).
type ProductInstancevalues ¶
type ProductInstancevalues struct {
// Default value. This is used whenever no listed exception matches the selected
// variant of a product.
Default *ProductInstanceValue `json:"default,omitempty"`
// Exceptions on the default values. Each exception lists the property values to
// match and the value lists the price (and optional) other content (such as a
// voucherid and the amount for a payment voucher).
Exceptions []*ProductInstanceException `json:"exceptions"`
}
Product instancevalues
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ProductInstancevalues).
type ProductProperty ¶
type ProductProperty struct {
// Name
Name string `json:"name"`
// Description
Description string `json:"description,omitempty"`
// Key
Key string `json:"key"`
// Values
Values []*KeyValueItem `json:"values"`
}
Product property
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ProductProperty).
type ProductQuery ¶
type ProductQuery struct {
// Only return items with the given typeid.
Typeid int64 `json:"typeid,omitempty"`
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter products.
More info: see product (https://www.ticketmatic.com/docs/api/types/Product), the getlist operation (https://www.ticketmatic.com/docs/api/settings/products/getlist) and the products endpoint (https://www.ticketmatic.com/docs/api/settings/products).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ProductQuery).
type ProductVoucherValue ¶
type ProductVoucherValue struct {
// Amount (only used for vouchers of type Payment)
Amount float64 `json:"amount,omitempty"`
// Voucher id
Voucherid int64 `json:"voucherid"`
}
Product Voucher Value
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ProductVoucherValue).
type PurgeOrdersRequest ¶ added in v1.0.45
type PurgeOrdersRequest struct {
// Also purge contacts
Contacts bool `json:"contacts"`
// Only purge orders created since this timestamp
Createdsince string `json:"createdsince"`
// Also purge events (incl. vouchers, products and bundles)
Events bool `json:"events"`
}
Info for requesting a purge of all orders.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/PurgeOrdersRequest).
type QueryRequest ¶
type QueryRequest struct {
// Optional limit for the result. Default 100
Limit int64 `json:"limit"`
// Optional offset for the result. Default 0
Offset int64 `json:"offset"`
// Actual query to execute
Query string `json:"query"`
}
Required data for creating a query on the public data model.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/QueryRequest).
type QueryResult ¶
type QueryResult struct {
// The number of rows in the result
Nbrofresults int64 `json:"nbrofresults"`
// The actual resulting rows
Results []map[string]interface{} `json:"results"`
}
Result of a query on the public data model.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/QueryResult).
type RateLimitError ¶
type RateLimitError struct {
Backoff int
}
Rate limit error
func (*RateLimitError) Error ¶
func (r *RateLimitError) Error() string
type RelationType ¶
type RelationType struct {
// Unique ID
//
// Note: Ignored when creating a new relation type.
//
// Note: Ignored when updating an existing relation type.
Id int64 `json:"id"`
// Name of the relation type
Name string `json:"name"`
// ID of the parent relation type.
Parentid int64 `json:"parentid"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new relation type.
//
// Note: Ignored when updating an existing relation type.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new relation type.
//
// Note: Ignored when updating an existing relation type.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new relation type.
//
// Note: Ignored when updating an existing relation type.
Lastupdatets Time `json:"lastupdatets"`
}
A single relation type.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/relationtypes/get) and the relation types endpoint (https://www.ticketmatic.com/docs/api/settings/system/relationtypes).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/RelationType).
type RelationTypeQuery ¶
type RelationTypeQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter relation types.
More info: see relation type (https://www.ticketmatic.com/docs/api/types/RelationType), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/relationtypes/getlist) and the relation types endpoint (https://www.ticketmatic.com/docs/api/settings/system/relationtypes).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/RelationTypeQuery).
type Report ¶
type Report struct {
// Unique ID
//
// Note: Ignored when creating a new report.
//
// Note: Ignored when updating an existing report.
Id int64 `json:"id"`
// Name of the report
Name string `json:"name"`
// The actual report definition, see reports
// (https://www.ticketmatic.com/docs/tickets/reporting_and_followup/reporting/) for
// more information.
//
// Note: Not set when retrieving a list of reports.
Content [][]map[string]interface{} `json:"content"`
// Reports can be generated as pdf or excel file. This field defines the default
// format. Possible values are 'pdf' or 'excel'
Defaultformat string `json:"defaultformat"`
// Description of the report
Description string `json:"description"`
// List of email recipients that should receive the report in bcc, separated by ;
Emailbcc string `json:"emailbcc"`
// List of email recipients that should receive the report in cc, separated by ;
Emailcc string `json:"emailcc"`
// List of email recipients that should receive the report, separated by ;
Emailrecipients string `json:"emailrecipients"`
// Indicates if this report is scheduled to be sent by mail at a certain interval
Emailschedule bool `json:"emailschedule"`
// Day of the month the report will be sent.
Emailscheduledayofmonth int64 `json:"emailscheduledayofmonth"`
// Day of the week the report will be sent. 1 = monday -> 7 = sunday
Emailscheduledayofweek int64 `json:"emailscheduledayofweek"`
// Hour of the day the report will be sent
Emailschedulehourofday int64 `json:"emailschedulehourofday"`
// Report will only be sent if the given query returns at least one result.
Emailschedulequery string `json:"emailschedulequery"`
// Key-value array of options. Can contain: pdfpagesize, excelpagewidth,
// excelscaling, usesystemfont
//
// Note: Not set when retrieving a list of reports.
Options *ReportOptions `json:"options,omitempty"`
// The report type defines the UI and parameters that are used when generating the
// report
Reporttypeid int64 `json:"reporttypeid"`
// A list of subtitles for the report
//
// Note: Not set when retrieving a list of reports.
Subtitles []string `json:"subtitles"`
// A map of language codes to gettext .po files
// (http://en.wikipedia.org/wiki/Gettext).
//
// Note: Not set when retrieving a list of reports.
Translations map[string]string `json:"translations,omitempty"`
// Indicates where the report is being used. Possible values: 17001 (Sales),
// 17002 (External sales), 17003 (Hidden)
Usagetypeid int64 `json:"usagetypeid"`
// Created timestamp
//
// Note: Ignored when creating a new report.
//
// Note: Ignored when updating an existing report.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new report.
//
// Note: Ignored when updating an existing report.
Lastupdatets Time `json:"lastupdatets"`
}
A single report.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/reports/get) and the reports endpoint (https://www.ticketmatic.com/docs/api/settings/system/reports).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Report).
type ReportOptions ¶
type ReportOptions struct {
// The pagesize for the report when exported as Excel.
Excelpagewidth int64 `json:"excelpagewidth"`
// Excel-specific option for scaling the width
Excelscaling float64 `json:"excelscaling"`
// The pagesize for the report: A4 landscape, Letter landscape, ...
Pdfpagesize string `json:"pdfpagesize"`
// Indicates if a system font should be used.
Usesystemfont bool `json:"usesystemfont"`
}
Report Options
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ReportOptions).
type ReportQuery ¶
type ReportQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter reports.
More info: see report (https://www.ticketmatic.com/docs/api/types/Report), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/reports/getlist) and the reports endpoint (https://www.ticketmatic.com/docs/api/settings/system/reports).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ReportQuery).
type Request ¶
type Request struct {
// contains filtered or unexported fields
}
API Request
func (*Request) AddParameter ¶
func (*Request) UrlParameters ¶
type RequestError ¶ added in v1.0.57
type RequestError struct {
StatusCode int `json:"code,omitempty"`
Body []byte `json:"-"`
Message string `json:"message,omitempty"`
ApplicationCode int `json:"applicationcode,omitempty"`
ApplicationData interface{} `json:"applicationdata,omitempty"`
}
Request error
func (*RequestError) Error ¶ added in v1.0.57
func (r *RequestError) Error() string
type SalesChannel ¶
type SalesChannel struct {
// Unique ID
//
// Note: Ignored when creating a new sales channel.
//
// Note: Ignored when updating an existing sales channel.
Id int64 `json:"id"`
// The type of this sales channel, defines where this sales channel will be used.
// The available values for this field can be found on the sales channel overview
// (https://www.ticketmatic.com/docs/api/settings/ticketsales/saleschannels) page.
Typeid int64 `json:"typeid"`
// Name of the sales channel
Name string `json:"name"`
// The ID of the order mail template to use for sending confirmations. Can be 0 to
// indicate that no mail should be sent
OrdermailtemplateidConfirmation int64 `json:"ordermailtemplateid_confirmation"`
// Always send the confirmation, regardless of the payment method configuration
OrdermailtemplateidConfirmationSendalways bool `json:"ordermailtemplateid_confirmation_sendalways"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new sales channel.
//
// Note: Ignored when updating an existing sales channel.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new sales channel.
//
// Note: Ignored when updating an existing sales channel.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new sales channel.
//
// Note: Ignored when updating an existing sales channel.
Lastupdatets Time `json:"lastupdatets"`
}
A single sales channel.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/ticketsales/saleschannels/get) and the sales channels endpoint (https://www.ticketmatic.com/docs/api/settings/ticketsales/saleschannels).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/SalesChannel).
type SalesChannelQuery ¶
type SalesChannelQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter sales channels.
More info: see sales channel (https://www.ticketmatic.com/docs/api/types/SalesChannel), the getlist operation (https://www.ticketmatic.com/docs/api/settings/ticketsales/saleschannels/getlist) and the sales channels endpoint (https://www.ticketmatic.com/docs/api/settings/ticketsales/saleschannels).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/SalesChannelQuery).
type SeatDescriptionTemplate ¶ added in v1.0.31
type SeatDescriptionTemplate struct {
// The ID of the template
Id int64 `json:"id"`
// The name of the template
Name string `json:"name"`
// The template itself with placeholders for rowname, seatname and zonename
Template string `json:"template"`
}
Templates to allow different seat description for seats
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/SeatDescriptionTemplate).
type SeatRank ¶
type SeatRank struct {
// Unique ID
//
// Note: Ignored when creating a new seat rank.
//
// Note: Ignored when updating an existing seat rank.
Id int64 `json:"id"`
// Name for the seat rank
Name string `json:"name"`
// The color of the seat rank
Color string `json:"color"`
// Priority of the seat rank
//
// Note: Not set when retrieving a list of seat ranks.
Priority int64 `json:"priority"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new seat rank.
//
// Note: Ignored when updating an existing seat rank.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new seat rank.
//
// Note: Ignored when updating an existing seat rank.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new seat rank.
//
// Note: Ignored when updating an existing seat rank.
Lastupdatets Time `json:"lastupdatets"`
}
A single seat rank.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/seatingplans/seatranks/get) and the seat ranks endpoint (https://www.ticketmatic.com/docs/api/settings/seatingplans/seatranks).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/SeatRank).
type SeatRankQuery ¶
type SeatRankQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter seat ranks.
More info: see seat rank (https://www.ticketmatic.com/docs/api/types/SeatRank), the getlist operation (https://www.ticketmatic.com/docs/api/settings/seatingplans/seatranks/getlist) and the seat ranks endpoint (https://www.ticketmatic.com/docs/api/settings/seatingplans/seatranks).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/SeatRankQuery).
type SeatingPlan ¶ added in v1.0.30
type SeatingPlan struct {
// Unique ID
//
// Note: Ignored when creating a new seating plan.
//
// Note: Ignored when updating an existing seating plan.
Id int64 `json:"id"`
// The name for the seating plan
Name string `json:"name"`
// The status this seating plan is in
Status string `json:"status"`
// Translations for the seat description templates
//
// Note: Not set when retrieving a list of seating plans.
Translations map[string]string `json:"translations,omitempty"`
// When true: treat as a multi-zoned seatingplan
Useszones bool `json:"useszones"`
// IDs of the seat zones defined
//
// Note: Ignored when creating a new seating plan.
//
// Note: Ignored when updating an existing seating plan.
//
// Note: Not set when retrieving a list of seating plans.
Zones []int64 `json:"zones"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new seating plan.
//
// Note: Ignored when updating an existing seating plan.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new seating plan.
//
// Note: Ignored when updating an existing seating plan.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new seating plan.
//
// Note: Ignored when updating an existing seating plan.
Lastupdatets Time `json:"lastupdatets"`
}
A single seating plan.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/seatingplans/seatingplans/get) and the seating plans endpoint (https://www.ticketmatic.com/docs/api/settings/seatingplans/seatingplans).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/SeatingPlan).
type SeatingPlanQuery ¶ added in v1.0.30
type SeatingPlanQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter seating plans.
More info: see seating plan (https://www.ticketmatic.com/docs/api/types/SeatingPlan), the getlist operation (https://www.ticketmatic.com/docs/api/settings/seatingplans/seatingplans/getlist) and the seating plans endpoint (https://www.ticketmatic.com/docs/api/settings/seatingplans/seatingplans).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/SeatingPlanQuery).
type ServicemailScheduling ¶ added in v1.0.118
type ServicemailScheduling struct {
// Amount of days before/after the event to send the mail.
Days int64 `json:"days"`
// Send the mail before or after the event.
Relative string `json:"relative"`
// The time (HH:MM) at which to send the mail.
Time string `json:"time"`
}
Scheduling used for planning of servicemails.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ServicemailScheduling).
type SetOrderCost ¶ added in v1.0.44
type SetOrderCost struct {
// The amount for this ordercost
Amount float64 `json:"amount,omitempty"`
// Id of the service charge to use for this ordercost
Servicechargedefinitionid int64 `json:"servicechargedefinitionid"`
}
Used to update order costs in an order.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/SetOrderCost).
type SplitOrder ¶ added in v1.0.90
type SplitOrder struct {
// The customer for the new order, when not provided will be the same as the
// current order.
Customerid int64 `json:"customerid"`
// The delivery scenario for the new order, when not provided will be the same as
// the current order.
Deliveryscenarioid int64 `json:"deliveryscenarioid"`
// The payment scenario for the new order, when not provided will be the same as
// the current order.
Paymentscenarioid int64 `json:"paymentscenarioid"`
// Product IDs that need to be moved from the current order to the new one
Products []int64 `json:"products"`
// Assign new barcodes to tickets?
RegenerateBarcodes bool `json:"regenerate_barcodes,omitempty"`
// Ticket IDs that need to be moved from the current order to the new one
Tickets []int64 `json:"tickets"`
}
Required data for splitting an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/SplitOrder).
type SubscriberCommunication ¶
type SubscriberCommunication struct {
// Name of the communication
Name string `json:"name,omitempty"`
// E-mail addresses to which the communication has been sent
Addresses []string `json:"addresses"`
// Optional description of the communication
Remark string `json:"remark,omitempty"`
// Timestamp for the communication
Ts Time `json:"ts,omitempty"`
}
A newly created communication
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/SubscriberCommunication).
type SubscriberSync ¶
type SubscriberSync struct {
// Subscriber e-mail
Email string `json:"email"`
// Subscriber first name
Firstname string `json:"firstname,omitempty"`
// Subscriber last name
Lastname string `json:"lastname,omitempty"`
// Previous value of the email field, to indicate a changed e-mail address.
//
// Used to find the correct contact. The normal email field will be used when this
// field is ommitted or empty.
Oldemail string `json:"oldemail,omitempty"`
// Whether or not the subscriber is still subscribed
Subscribed bool `json:"subscribed"`
}
A subscriber record to sync state back to Ticketmatic
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/SubscriberSync).
type TicketFee ¶
type TicketFee struct {
// Unique ID
//
// Note: Ignored when creating a new ticket fee.
//
// Note: Ignored when updating an existing ticket fee.
Id int64 `json:"id"`
// Name for the ticket fee scheme
Name string `json:"name"`
// Definition of the rules that define when the ticket fee will be applied
//
// Note: Not set when retrieving a list of ticket fees.
Rules *TicketfeeRules `json:"rules,omitempty"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new ticket fee.
//
// Note: Ignored when updating an existing ticket fee.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new ticket fee.
//
// Note: Ignored when updating an existing ticket fee.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new ticket fee.
//
// Note: Ignored when updating an existing ticket fee.
Lastupdatets Time `json:"lastupdatets"`
}
A single ticket fee.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/pricing/ticketfees/get) and the ticket fees endpoint (https://www.ticketmatic.com/docs/api/settings/pricing/ticketfees).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketFee).
type TicketFeeQuery ¶
type TicketFeeQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter ticket fees.
More info: see ticket fee (https://www.ticketmatic.com/docs/api/types/TicketFee), the getlist operation (https://www.ticketmatic.com/docs/api/settings/pricing/ticketfees/getlist) and the ticket fees endpoint (https://www.ticketmatic.com/docs/api/settings/pricing/ticketfees).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketFeeQuery).
type TicketLayout ¶
type TicketLayout struct {
// Unique ID
//
// Note: Ignored when creating a new ticket layout.
//
// Note: Ignored when updating an existing ticket layout.
Id int64 `json:"id"`
// Type ID
//
// Note: Ignored when updating an existing ticket layout.
Typeid int64 `json:"typeid"`
// Name for the ticket layout
Name string `json:"name"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new ticket layout.
//
// Note: Ignored when updating an existing ticket layout.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new ticket layout.
//
// Note: Ignored when updating an existing ticket layout.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new ticket layout.
//
// Note: Ignored when updating an existing ticket layout.
Lastupdatets Time `json:"lastupdatets"`
}
A single ticket layout.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ticketlayouts/get) and the ticket layouts endpoint (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ticketlayouts).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketLayout).
type TicketLayoutQuery ¶
type TicketLayoutQuery struct {
// Only return items with the given typeid.
Typeid int64 `json:"typeid,omitempty"`
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter ticket layouts.
More info: see ticket layout (https://www.ticketmatic.com/docs/api/types/TicketLayout), the getlist operation (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ticketlayouts/getlist) and the ticket layouts endpoint (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ticketlayouts).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketLayoutQuery).
type TicketLayoutTemplate ¶
type TicketLayoutTemplate struct {
// Unique ID
//
// Note: Ignored when creating a new ticket layout template.
//
// Note: Ignored when updating an existing ticket layout template.
Id int64 `json:"id"`
// Type ID
//
// Note: Ignored when updating an existing ticket layout template.
Typeid int64 `json:"typeid"`
// Name for the ticket layout template
Name string `json:"name"`
// Css classes for the ticket layout template
//
// Note: Not set when retrieving a list of ticket layout templates.
Css string `json:"css"`
// Deliveryscenario's for which this ticket layout template will be used
Deliveryscenarios []int64 `json:"deliveryscenarios"`
// HTML template containing the definition for the ticket layout template
//
// Note: Not set when retrieving a list of ticket layout templates.
Htmltemplate string `json:"htmltemplate"`
// Number of tickets to be printed per page
Ticketsperpage int64 `json:"ticketsperpage"`
// Translations for the ticket layout template
//
// Note: Not set when retrieving a list of ticket layout templates.
Translations map[string]string `json:"translations,omitempty"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new ticket layout template.
//
// Note: Ignored when updating an existing ticket layout template.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new ticket layout template.
//
// Note: Ignored when updating an existing ticket layout template.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new ticket layout template.
//
// Note: Ignored when updating an existing ticket layout template.
Lastupdatets Time `json:"lastupdatets"`
}
A single ticket layout template.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ticketlayouttemplates/get) and the ticket layout templates endpoint (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ticketlayouttemplates).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketLayoutTemplate).
type TicketLayoutTemplateQuery ¶
type TicketLayoutTemplateQuery struct {
// Only return items with the given typeid.
Typeid int64 `json:"typeid,omitempty"`
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter ticket layout templates.
More info: see ticket layout template (https://www.ticketmatic.com/docs/api/types/TicketLayoutTemplate), the getlist operation (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ticketlayouttemplates/getlist) and the ticket layout templates endpoint (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/ticketlayouttemplates).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketLayoutTemplateQuery).
type TicketfeeException ¶
type TicketfeeException struct {
// The pricetype for which this exception is active.
Pricetypeid int64 `json:"pricetypeid"`
// The set of rules (one for each saleschannel).
Saleschannels []*TicketfeeSaleschannelRule `json:"saleschannels"`
}
An exception to the default rule for a specific pricetype and a set of saleschannels.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketfeeException).
type TicketfeeRules ¶
type TicketfeeRules struct {
// The default ticket fee rule, one rule for each saleschannel.
Default []*TicketfeeSaleschannelRule `json:"default"`
// An array of exception rules for specific pricetypes.
Exceptions []*TicketfeeException `json:"exceptions"`
}
Defines which fees are active for specific price types and sales channels. It's possible to define a fixed fee and a percentage based fee. The default rule (if none is specified for a specific sales channel) is always a fixed fee of 0.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketfeeRules).
type TicketfeeSaleschannelRule ¶
type TicketfeeSaleschannelRule struct {
// The saleschannel for which this rule is active.
Saleschannelid int64 `json:"saleschannelid"`
// The status sets the type of rule. Possible values:
//
// * fixedfee: A fixed ticket fee.
//
// * percentagefee: A fee thats a percentage of the ticket.
Status string `json:"status"`
// The value of this ticket fee. Can be an absolute amount (fixedfee) or a
// percentage (percentagefee). In both cases only provide a decimal.
Value float64 `json:"value"`
}
This is a rule for a specific saleschannel that indicates the fee based on a fixed amount or a percentage.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketfeeSaleschannelRule).
type TicketsEmaildeliveryRequest ¶
type TicketsEmaildeliveryRequest struct {
// Template id
Templateid int64 `json:"templateid"`
}
Info for requesting a e-mail delivery for an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketsEmaildeliveryRequest).
type TicketsPdfRequest ¶
type TicketsPdfRequest struct {
// Ticketids
Tickets []int64 `json:"tickets"`
// Vouchercodeids
Vouchercodes []int64 `json:"vouchercodes"`
}
Info for requesting a PDF ticket for one or more tickets or vouchercodes in an order (https://www.ticketmatic.com/docs/api/types/Order).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketsPdfRequest).
type TicketsalesFlowConfig ¶ added in v1.0.95
type TicketsalesFlowConfig struct {
// Start timestamp for this config
From Time `json:"from,omitempty"`
// End timestamp for this config
Until Time `json:"until,omitempty"`
// Widget to use in this config
Widget string `json:"widget,omitempty"`
// Widget parameters for this config
Widgetparams map[string]string `json:"widgetparams,omitempty"`
}
Config for a ticket sales flow
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketsalesFlowConfig).
type Ticketsalesflow ¶ added in v1.0.98
type Ticketsalesflow struct {
// Unique ID
//
// Note: Ignored when creating a new ticketsalesflow.
//
// Note: Ignored when updating an existing ticketsalesflow.
Id int64 `json:"id"`
// Name
Name string `json:"name"`
// Fielddefinition used to define the availability of events for this flow
Availabilityfielddefinition string `json:"availabilityfielddefinition"`
// Unique code used for the flow. Should only contain lower case letters and digits
Code string `json:"code"`
// Config for the flow
Config []*TicketsalesFlowConfig `json:"config"`
// Description
Description string `json:"description"`
// For flows with supported parameter 'product': the set of ProductTypes for which
// this flow is available
Productavailability []int64 `json:"productavailability"`
// Supported parameters for the flow
Supportedparameters []string `json:"supportedparameters"`
// Whether or not the flow is in test mode
Testmode bool `json:"testmode"`
// Ticket sales setup this flow belongs to
Ticketsalessetupid int64 `json:"ticketsalessetupid"`
}
A single ticketsalesflow.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/ticketsalesflows/get) and the ticketsalesflows endpoint (https://www.ticketmatic.com/docs/api/settings/system/ticketsalesflows).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Ticketsalesflow).
type TicketsalesflowQuery ¶ added in v1.0.98
type TicketsalesflowQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter ticketsalesflows.
More info: see ticketsalesflow (https://www.ticketmatic.com/docs/api/types/Ticketsalesflow), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/ticketsalesflows/getlist) and the ticketsalesflows endpoint (https://www.ticketmatic.com/docs/api/settings/system/ticketsalesflows).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketsalesflowQuery).
type Ticketsalessetup ¶ added in v1.0.98
type Ticketsalessetup struct {
// Unique ID
//
// Note: Ignored when creating a new ticketsalessetup.
//
// Note: Ignored when updating an existing ticketsalessetup.
Id int64 `json:"id"`
// Name
Name string `json:"name"`
// Unique code used for the public link to the ticketsalessetup docs
Code string `json:"code"`
// Whether or not the ticket sales setup is integrated with the website
Integrated bool `json:"integrated"`
// Widget parameters used for all flows in this setup
Widgetparams map[string]string `json:"widgetparams,omitempty"`
}
A single ticketsalessetup.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/ticketsalessetups/get) and the ticketsalessetups endpoint (https://www.ticketmatic.com/docs/api/settings/system/ticketsalessetups).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Ticketsalessetup).
type TicketsalessetupQuery ¶ added in v1.0.98
type TicketsalessetupQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter ticketsalessetups.
More info: see ticketsalessetup (https://www.ticketmatic.com/docs/api/types/Ticketsalessetup), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/ticketsalessetups/getlist) and the ticketsalessetups endpoint (https://www.ticketmatic.com/docs/api/settings/system/ticketsalessetups).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketsalessetupQuery).
type TicketsprocessedRequest ¶
type TicketsprocessedRequest struct {
// End date of the period
Endts string `json:"endts"`
// How the results are grouped. Values can be 'day' or 'month'
Groupby string `json:"groupby"`
// Start date of the period
Startts string `json:"startts"`
}
Required data for requesting the ticketsprocessedstatistics.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketsprocessedRequest).
type TicketsprocessedStatistics ¶
type TicketsprocessedStatistics struct {
// The number of tickets processed
Processed int64 `json:"processed"`
// The number of tickets sold online
Soldonline int64 `json:"soldonline"`
// Start of the period
Ts Time `json:"ts"`
}
Statistics on the number of tickets processed in a certain period.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/TicketsprocessedStatistics).
type Time ¶
type Time struct {
// contains filtered or unexported fields
}
Time is a wrapper that takes care of correct time serialization. You can easily convert from/to a normal time.Time using the NewTime() and Time() functions.
func (*Time) UnmarshalJSON ¶
Custom unmarshalling to handle the different time formats that may be returned by Ticketmatic.
type Timestamp ¶
type Timestamp struct {
// Current system time
Systemtime Time `json:"systemtime,omitempty"`
}
A timestamp returned by the diagnostic /time call (https://www.ticketmatic.com/docs/api/diagnostics/time).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Timestamp).
type UpdateOrder ¶
type UpdateOrder struct {
// New customer ID
Customerid int64 `json:"customerid,omitempty"`
// Change custom field values
Customfields map[string]interface{} `json:"customfields,omitempty"`
// Delivery address
Deliveryaddress *Address `json:"deliveryaddress,omitempty"`
// New delivery scenario ID
Deliveryscenarioid int64 `json:"deliveryscenarioid,omitempty"`
// Expiry timestamp, as string in ISO 8601 format. Cannot be in the past.
Expiryts string `json:"expiryts,omitempty"`
// Set manual order costs. Setting the amount to 0 will remove the order cost from
// the order.
Ordercosts []*SetOrderCost `json:"ordercosts"`
// New payment scenario ID
Paymentscenarioid int64 `json:"paymentscenarioid,omitempty"`
// Rappel timestamp, as string in ISO 8601 format. Cannot be in the past.
Rappelts string `json:"rappelts,omitempty"`
}
Used to update an order. Each of the fields is optional. Omitting a field will leave it unchanged.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/UpdateOrder).
type UpdateProducts ¶
type UpdateProducts struct {
// Operation to execute.
//
// Supported values:
//
// * setproductholders
Operation string `json:"operation"`
// Operation parameters
Params map[string]interface{} `json:"params,omitempty"`
// Product IDs
Products []int64 `json:"products"`
}
Individual products can be updated. Per call you can specify any number of product IDs and one operation.
Each operation accepts different parameters, dependent on the operation type:
* Set product holders: an array of ticket holder IDs (see Contact (https://www.ticketmatic.com/docs/api/types/Contact)), one for each product (productholderids). *
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/UpdateProducts).
type UpdateTickets ¶
type UpdateTickets struct {
// Operation to execute.
//
// Supported values:
//
// * setticketholders
//
// * updatepricetype
//
// * addtobundles
//
// * removefrombundles
Operation string `json:"operation"`
// Operation parameters
Params map[string]interface{} `json:"params,omitempty"`
// Ticket IDs
Tickets []int64 `json:"tickets"`
}
Individual tickets can be updated. Per call you can specify any number of ticket IDs and one operation.
Each operation accepts different parameters, dependent on the operation type:
* Set ticket holders: an array of ticket holder IDs (see Contact (https://www.ticketmatic.com/docs/api/types/Contact)), one for each ticket (ticketholderids).
* Update price type: an array of ticket price type IDs (as can be found in the Event pricing (https://www.ticketmatic.com/docs/api/types/Event)), one for each ticket (tickettypepriceids)
* Add to bundles: an array of bundle IDs, one for each ticket
* Remove from bundles: none.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/UpdateTickets).
type Url ¶
type Url struct {
// Url.
Url string `json:"url"`
}
Url.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Url).
type View ¶
type View struct {
// Unique ID
//
// Note: Ignored when creating a new view.
//
// Note: Ignored when updating an existing view.
Id int64 `json:"id"`
// Type ID
//
// Note: Ignored when updating an existing view.
Typeid int64 `json:"typeid"`
// Name of the view
Name string `json:"name"`
// List of field definitions that are part of this view.
Columns []*ViewColumn `json:"columns"`
// The field definitions to order the results on.
Orderby int64 `json:"orderby"`
// Indicates whether the results should be ordered ascending or descending.
OrderbyAsc bool `json:"orderby_asc"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new view.
//
// Note: Ignored when updating an existing view.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new view.
//
// Note: Ignored when updating an existing view.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new view.
//
// Note: Ignored when updating an existing view.
Lastupdatets Time `json:"lastupdatets"`
}
A single view.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/system/views/get) and the views endpoint (https://www.ticketmatic.com/docs/api/settings/system/views).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/View).
type ViewColumn ¶
type ViewColumn struct {
// ID of the field definition for this column.
Id int64 `json:"id"`
}
View column for a view.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ViewColumn).
type ViewQuery ¶
type ViewQuery struct {
// Only return items with the given typeid.
Typeid int64 `json:"typeid"`
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter views.
More info: see view (https://www.ticketmatic.com/docs/api/types/View), the getlist operation (https://www.ticketmatic.com/docs/api/settings/system/views/getlist) and the views endpoint (https://www.ticketmatic.com/docs/api/settings/system/views).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/ViewQuery).
type Voucher ¶
type Voucher struct {
// Unique ID
//
// Note: Ignored when creating a new voucher.
//
// Note: Ignored when updating an existing voucher.
Id int64 `json:"id"`
// Type ID
//
// Note: Ignored when updating an existing voucher.
Typeid int64 `json:"typeid"`
// Name of the voucher
Name string `json:"name"`
// Format used when generating codes for the voucher. Possible values:
//
// * 27001: 12 digits
//
// * 27002: 16 digits
//
// * 27003: 8 alphanumerical characters
//
// * 27004: 12 alphanumerical characters
//
// * 27005: 16 alphanumerical characters
//
// * 27099: Specified from list, not autogenerated
Codeformatid int64 `json:"codeformatid"`
// If set, the codes that are generated are padded with this prefix. This can be
// used to ensure that vouchercodes are unique. The prefix can be max 10 characters
// long.
//
// Note: Not set when retrieving a list of vouchers.
Codeprefix string `json:"codeprefix"`
// Description of the voucher
Description string `json:"description"`
// The number of codes that were created for this voucher.
//
// Note: Ignored when creating a new voucher.
//
// Note: Ignored when updating an existing voucher.
Nbrofcodes int64 `json:"nbrofcodes"`
// A validation script that is used for vouchers of type order. For each order with
// a voucher of this type attached, the script will be run to validate the contents
Ordervalidationscript string `json:"ordervalidationscript,omitempty"`
// Paymentmethod to use when creating payments for vouchers of type payment.
// This field is required when a payment voucher is created. The paymentmethod that
// is referred to should be of a voucher type.
Paymentmethodid int64 `json:"paymentmethodid,omitempty"`
// Definition of the validity of this voucher. Depends on the typeid.
//
// Note: Not set when retrieving a list of vouchers.
Validity *VoucherValidity `json:"validity,omitempty"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new voucher.
//
// Note: Ignored when updating an existing voucher.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new voucher.
//
// Note: Ignored when updating an existing voucher.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new voucher.
//
// Note: Ignored when updating an existing voucher.
Lastupdatets Time `json:"lastupdatets"`
}
A single voucher.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/vouchers/get) and the vouchers endpoint (https://www.ticketmatic.com/docs/api/settings/vouchers).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/Voucher).
type VoucherCode ¶
type VoucherCode struct {
// Code to use voucher
Code string `json:"code"`
// Expiry timestamp for this code
Expiryts Time `json:"expiryts,omitempty"`
}
Voucher code
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/VoucherCode).
type VoucherQuery ¶
type VoucherQuery struct {
// Only return items with the given typeid.
Typeid int64 `json:"typeid,omitempty"`
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter vouchers.
More info: see voucher (https://www.ticketmatic.com/docs/api/types/Voucher), the getlist operation (https://www.ticketmatic.com/docs/api/settings/vouchers/getlist) and the vouchers endpoint (https://www.ticketmatic.com/docs/api/settings/vouchers).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/VoucherQuery).
type VoucherValidity ¶
type VoucherValidity struct {
// The fixed expiry date for a voucher. The voucher will be valid untill
// this date (thus if 2020-01-01 is specified, the voucher will remain valid
// until 2019-12-31 23:59:59). If this is specified, it has preference over
// expiry_monthsaftercreation.
ExpiryFixeddate Time `json:"expiry_fixeddate,omitempty"`
// The relative expiry date for a voucher: voucher code expires this number of
// months after creation. If expiry_fixeddate is specified, this field is ignored.
ExpiryMonthsaftercreation int64 `json:"expiry_monthsaftercreation,omitempty"`
// The max number of times the vouchercode can be used. This field is only relevant
// for pricetype vouchers.
Maxusages int64 `json:"maxusages,omitempty"`
// The max number of times the vouchercode can be used for a single event. This
// field is only relevant for pricetype vouchers.
Maxusagesperevent int64 `json:"maxusagesperevent,omitempty"`
}
The definition of the validity of a voucher.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/VoucherValidity).
type WaitingListRequest ¶ added in v1.0.81
type WaitingListRequest struct {
// Unique ID
//
// Note: Ignored when creating a new waiting list request.
//
// Note: Ignored when updating an existing waiting list request.
Id int64 `json:"id"`
// The id of the order the request is converted to
Orderid int64 `json:"orderid"`
// Contact id
Contactid int64 `json:"contactid"`
// Show the status of the related items, 29101 = no information provided, 29102 =
// partial information provided and 29103 = full information provided
Itemsstatus int64 `json:"itemsstatus"`
// Show the status of the request, 29201 = requested, 29202 = processed, 29203 =
// conversion in progress
Requeststatus int64 `json:"requeststatus"`
// The id of the saleschannel used to make the request
Saleschannelid int64 `json:"saleschannelid"`
// Randomly generated identifier on create. Provides random but consistent ordering
// of the request (for casting lots)
//
// Note: Ignored when updating an existing waiting list request.
Sortorder int64 `json:"sortorder"`
// The request items per event
//
// Note: Not set when retrieving a list of waiting list requests.
Waitinglistrequestitems []*WaitingListRequestItem `json:"waitinglistrequestitems"`
// Whether or not this item is archived
//
// Note: Ignored when creating a new waiting list request.
//
// Note: Ignored when updating an existing waiting list request.
Isarchived bool `json:"isarchived"`
// Created timestamp
//
// Note: Ignored when creating a new waiting list request.
//
// Note: Ignored when updating an existing waiting list request.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new waiting list request.
//
// Note: Ignored when updating an existing waiting list request.
Lastupdatets Time `json:"lastupdatets"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A single waiting list request.
More info: see the get operation (https://www.ticketmatic.com/docs/api/sales/waitinglistrequests/get) and the waiting list requests endpoint (https://www.ticketmatic.com/docs/api/sales/waitinglistrequests).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/WaitingListRequest).
func (*WaitingListRequest) MarshalJSON ¶ added in v1.0.81
func (o *WaitingListRequest) MarshalJSON() ([]byte, error)
Custom marshaller with support for custom fields
func (*WaitingListRequest) UnmarshalJSON ¶ added in v1.0.81
func (o *WaitingListRequest) UnmarshalJSON(data []byte) error
Custom unmarshaller with support for custom fields
type WaitingListRequestItem ¶ added in v1.0.81
type WaitingListRequestItem struct {
// The event for which there are tickets requested
Eventid int64 `json:"eventid"`
// The requested tickets for the event, identified by tickettypepriceid
Tickets []*WaitingListRequestItemTicket `json:"tickets"`
// Custom fields
CustomFields map[string]interface{} `json:"-"`
}
A waitinglistrequestitem is a single event and the requested tickets in a waitinglistrequest
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/WaitingListRequestItem).
func (*WaitingListRequestItem) MarshalJSON ¶ added in v1.0.105
func (o *WaitingListRequestItem) MarshalJSON() ([]byte, error)
Custom marshaller with support for custom fields
func (*WaitingListRequestItem) UnmarshalJSON ¶ added in v1.0.105
func (o *WaitingListRequestItem) UnmarshalJSON(data []byte) error
Custom unmarshaller with support for custom fields
type WaitingListRequestItemTicket ¶ added in v1.0.81
type WaitingListRequestItemTicket struct {
// The tickettypepriceid of the ticket
Tickettypepriceid int64 `json:"tickettypepriceid"`
}
A ticket requested in a waitinglistrequestitem
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/WaitingListRequestItemTicket).
type WaitingListRequestQuery ¶ added in v1.0.81
type WaitingListRequestQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// If this parameter is true, archived items will be returned as well.
Includearchived bool `json:"includearchived,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter waiting list requests.
More info: see waiting list request (https://www.ticketmatic.com/docs/api/types/WaitingListRequest), the getlist operation (https://www.ticketmatic.com/docs/api/sales/waitinglistrequests/getlist) and the waiting list requests endpoint (https://www.ticketmatic.com/docs/api/sales/waitinglistrequests).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/WaitingListRequestQuery).
type WebSalesSkin ¶
type WebSalesSkin struct {
// Unique ID
//
// Note: Ignored when creating a new web sales skin.
//
// Note: Ignored when updating an existing web sales skin.
Id int64 `json:"id"`
// Name of the web sales skin
Name string `json:"name"`
// The URL where the assets are stored for this webskin. This property is readonly.
//
// Note: Ignored when creating a new web sales skin.
//
// Note: Ignored when updating an existing web sales skin.
//
// Note: Not set when retrieving a list of web sales skins.
Asseturl string `json:"asseturl"`
// Skin configuration.
//
// See the WebSalesSkinConfiguration reference
// (https://www.ticketmatic.com/docs/api/types/WebSalesSkinConfiguration) for an
// overview of all possible options.
//
// Note: Not set when retrieving a list of web sales skins.
Configuration *WebSalesSkinConfiguration `json:"configuration,omitempty"`
// CSS style rules. Should always include the style import.
//
// Note: Not set when retrieving a list of web sales skins.
Css string `json:"css"`
// HTML template of the skin. See the web skin setup guide
// (https://www.ticketmatic.com/docs/tickets/configure_ticket_sales/webskin) for
// more information.
//
// Note: Not set when retrieving a list of web sales skins.
Html string `json:"html"`
// A map of language codes to gettext .po files
// (http://en.wikipedia.org/wiki/Gettext).
// More info can be found on the web skin overview
// (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/webskins)
// page.
//
// Note: Not set when retrieving a list of web sales skins.
Translations map[string]string `json:"translations,omitempty"`
// Created timestamp
//
// Note: Ignored when creating a new web sales skin.
//
// Note: Ignored when updating an existing web sales skin.
Createdts Time `json:"createdts"`
// Last updated timestamp
//
// Note: Ignored when creating a new web sales skin.
//
// Note: Ignored when updating an existing web sales skin.
Lastupdatets Time `json:"lastupdatets"`
}
A single web sales skin.
More info: see the get operation (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/webskins/get) and the web sales skins endpoint (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/webskins).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/WebSalesSkin).
type WebSalesSkinConfiguration ¶
type WebSalesSkinConfiguration struct {
// Asset path to favicon image.
Favicon string `json:"favicon"`
// Deprecated, use Google Tag Manager.
Googleanalyticsid string `json:"googleanalyticsid"`
// Google Tag Manager ID. Can be left blank.
Googletagmanagerid string `json:"googletagmanagerid"`
// Page title
Title string `json:"title"`
}
Configuration settings and parameters for a web sales skin (https://www.ticketmatic.com/docs/api/types/WebSalesSkin).
Page titles ¶
The title field contains a template for the page title. The same variables as in the HTML of the skin itself can be used.
Check the web sales skin setup guide (https://www.ticketmatic.com/docs/tickets/configure_ticket_sales/webskin) for more information.
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/WebSalesSkinConfiguration).
type WebSalesSkinQuery ¶
type WebSalesSkinQuery struct {
// Filter the returned items by specifying a query on the public datamodel that
// returns the ids.
Filter string `json:"filter,omitempty"`
// All items that were updated since this timestamp will be returned. Timestamp
// should be passed in YYYY-MM-DD hh:mm:ss format.
Lastupdatesince Time `json:"lastupdatesince,omitempty"`
}
Set of parameters used to filter web sales skins.
More info: see web sales skin (https://www.ticketmatic.com/docs/api/types/WebSalesSkin), the getlist operation (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/webskins/getlist) and the web sales skins endpoint (https://www.ticketmatic.com/docs/api/settings/communicationanddesign/webskins).
Help Center ¶
Full documentation can be found in the Ticketmatic Help Center (https://www.ticketmatic.com/docs/api/types/WebSalesSkinQuery).
type Widgets ¶
Widget helper
func NewWidgets ¶
func (*Widgets) GenerateUrl ¶
func (*Widgets) VerifyFormReturnUrl ¶ added in v1.0.52
This variant of VerifyReturnUrl allows you to pass in req.Form directly
Directories
¶
| Path | Synopsis |
|---|---|
|
Contact manipulation operations
|
Contact manipulation operations |
|
Diagnostic API calls to help while debugging.
|
Diagnostic API calls to help while debugging. |
|
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). |
|
Event stream to poll events in the account.
|
Event stream to poll events in the account. |
|
API calls for jobs.
|
API calls for jobs. |
|
Orders are one of the main concepts in Ticketmatic.
|
Orders are one of the main concepts in Ticketmatic. |
|
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. |
|
accountparameters
Account parameters control central parameters related to your account.
|
Account parameters control central parameters related to your account. |
|
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)
|
Ticketmatic allows you to create documents for contacts and orders, you can read more in this article (https://www.ticketmatic.com/docs/setup/document) |
|
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. |
|
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. |
|
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. |
|
communicationanddesign/webskins
Web sales skins define skins for the web sales interface.
|
Web sales skins define skins for the web sales interface. |
|
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. |
|
pricing/orderfeedefinitions
Order fee definitions
|
Order fee definitions |
|
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. |
|
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. |
|
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. |
|
productcategories
Each product belongs to a product category.
|
Each product belongs to a product category. |
|
products
Product types
|
Product types |
|
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. |
|
seatingplans/seatranks
Seat ranks
|
Seat ranks |
|
system/contactaddresstypes
Address types allow you to attach a type to different addresses.
|
Address types allow you to attach a type to different addresses. |
|
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. |
|
system/contacttitles
Contact titles are used to define different titles for contacts.
|
Contact titles are used to define different titles for contacts. |
|
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. |
|
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). |
|
system/dupedetectrules
Dupe detect rules are used for contact deduplication.
|
Dupe detect rules are used for contact deduplication. |
|
system/fielddefinitions
Field definition types
|
Field definition types |
|
system/filterdefinitions
Filter definitions define filters that can be used in the backoffice.
|
Filter definitions define filters that can be used in the backoffice. |
|
system/optins
Define a set of opt ins for your customers regarding .
|
Define a set of opt ins for your customers regarding . |
|
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. |
|
system/relationtypes
Relation types can be used to introduce a hierarchy of contacts.
|
Relation types can be used to introduce a hierarchy of contacts. |
|
system/reports
Report types
|
Report types |
|
system/ticketsalesflows
Ticket sales flows
|
Ticket sales flows |
|
system/ticketsalessetups
Ticket sales setup
|
Ticket sales setup |
|
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. |
|
ticketsales/deliveryscenarios
A delivery scenario defines how an order will be delivered.
|
A delivery scenario defines how an order will be delivered. |
|
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. |
|
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. |
|
ticketsales/paymentmethods
A payment method defines the method of an actual payment.
|
A payment method defines the method of an actual payment. |
|
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. |
|
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). |
|
vouchers
Voucher types
|
Voucher types |
|
Subscribers are Contacts that are subscribed for e-mail marketing actions.
|
Subscribers are Contacts that are subscribed for e-mail marketing actions. |
|
Miscellaneous tools for retrieving information from the account.
|
Miscellaneous tools for retrieving information from the account. |