List of Ticket-Orders
GET https://api.e-guma.ch/v1/ticketing/orders.json?apikey={api-key}Parameters
| Parameter | Description |
|---|---|
api-key required | |
| updated_at_after | Show orders modified at or after date (format: 2019-06-04T23:15:14). |
| updated_at_before | Show orders modified before date (format: 2019-07-04T23:15:14). |
| order_number | The sequential number of the order, e.g., 1000001. |
| last_name | The last name of the person associated with the order. It is case-sensitive. |
Return
| Parameter | Description |
|---|---|
| id | The ID of the order. |
| created_at | The autogenerated date and time (ISO 8601 format) when the order was created. E.g. 2019-06-03T19:16:43. |
| updated_at | The date and time (ISO 8601 format) when the order was last modified. When an order is created then updated_at has the same value as created_at. |
| order_number | The order number. |
| status | completed or cancelled. |
| currency | The three-letter code (ISO 4217 format) for the currency. Each shop only supports one currency. |
| language | Language as a two-letter code (ISO 639-1). |
| location | web or local. |
| note | This field combines the internal and external notes. |
| tags | List of tags. If there are no tags, an empty array is returned. |
| discount_in_cents | The total discounts applied to the price of the order. |
| grand_total_in_cents | The sum of all line item prices, shipping fee, and added discounts. |
| promocode | The used promocode. If no promocode is used, null is returned. |
| promocode_name | The internal name of the used promocode. If no promocode is used, null is returned. |
| customer | Customer, see customer object below for details. The customer object can be null. |
| order_lines | List of order lines, see order line object below for details. |
| payments | List of payments, see payment object below for details. |
Customer object
| Parameter | Description |
|---|---|
| id | The ID of the customer. |
| title | Mr, Mrs or Company. |
| first_name | First name. |
| last_name | Last name. |
| company | Company name. |
| street | Street. |
| zip | Zip code. |
| city | City. |
| country | Country as two-letter code (ISO 3166-1 alpha-2). |
| Email address. | |
| accepts_marketing | Whether the customer consented (Double Opt-in) to receive email newsletters. |
| double_opt_in_confirmed_at | If the customer consented to receive the email newsletter, then the date and time (ISO 8601 format) of the Double Opt-in will be returned. Otherwise, this value will be null. |
| phone | Phone number. |
Order line object
| product_id | The ID of the product. |
| name | The name of the event or admission (e.g. Magical Brunch). |
| starts_at | Date and time (ISO 8601 format) when the event occurs. This value is null for admission-tickets without a start date. |
| ticket_type_id | The id of the ticket type |
| ticket_type_name | The name of the ticket type (e.g. Normal price) |
| quantity | Quantity |
| total_price_in_cents | quantity x unit_price_in_cents |
| tags | List of tags. If there are no tags, an empty array is returned. |
| total_count_people | Count of people for this ticket type. This value corresponds to this setting. |
| tickets | List of tickets. |
Ticket object
| number | The ticket number. |
| count_people | Count of people per ticket. Default value is 1 (ticket for one person). |
| answers | List of answers to ticket questions. Answers can be null. If there are no questions, an empty array is returned. |
Payment object
| payment_id | The ID of the payment method. |
| name | The name of the payment method. E.g. Credit Card |
| amount_in_cents | Amount |
| is_complimentary | Indicates if a payment is complimentary. |
Example
GET https://api.e-guma.ch/v1/ticketing/orders.json?updated_at_after=2025-01-21T10:00:00&apikey=6731db84973b860a08f4023c[
{
"id": "678f6cde973b8604d43af956",
"created_at": "2025-01-21T10:46:05",
"updated_at": "2025-01-21T10:46:05",
"order_number": "1000572",
"status": "completed",
"currency": "CHF",
"language": "en",
"location": "web",
"discount_in_cents": 0,
"grand_total_in_cents": 5000,
"promocode": "12345",
"promocode_name": "Sample promocode",
"customer": {
"id": "0f580e21-67dd-43d8-b097-72fd75a1acba",
"title": "Mr",
"first_name": "Christoph",
"last_name": "Lehner",
"company": "Idea Creation GmbH",
"street": "Walchestrasse 15",
"zip": "8006",
"city": "Zürich",
"country": "CH",
"email": "ch.lehner@e-guma.ch",
"accepts_marketing": false,
"double_opt_in_confirmed_at": null,
"phone": "044 500 54 00"
},
"order_lines": [
{
"product_id": "678f5130973b950bb88d3f7a",
"name": "Magical Brunch",
"starts_at": "2027-01-21T20:00:00",
"ticket_type_id": "caeadb8f-2b6d-424c-ad8a-4caf42505691",
"ticket_type_name": "Normalpreis",
"unit_price_in_cents": 5000,
"quantity": 1,
"total_price_in_cents": 5000,
"total_count_people": 1,
"tags": [],
"tickets": [
{
"number": "5679006056898985032",
"count_people": 1,
"answers": [
{
"name": "First name",
"type": "text",
"value": "John"
},
{
"name": "Last name",
"type": "text",
"value": "Doe"
},
{
"name": "Birthday",
"type": "dateTime",
"value": "1990-12-31"
},
{
"name": "Company",
"type": "text",
"value": "e-guma"
},
{
"name": "Open question",
"type": "text",
"value": "Sample text"
},
{
"name": "Select",
"type": "optionId",
"value": null
}
]
}
]
},
{
"product_id": "678f5130973b950bb88d3f7a",
"name": "Magical Brunch",
"starts_at": "2027-01-21T20:00:00",
"ticket_type_id": "d05b4d7a-4ca7-41c4-b203-35d6106c1c8a",
"ticket_type_name": "Gratisticket",
"unit_price_in_cents": 0,
"quantity": 1,
"total_price_in_cents": 0,
"total_count_people": 1,
"tags": [],
"tickets": [
{
"number": "5177348347062652981",
"count_people": 1,
"answers": [
{
"name": "First name",
"type": "text",
"value": ""
},
{
"name": "Last name",
"type": "text",
"value": ""
},
{
"name": "Birthday",
"type": "dateTime",
"value": null
},
{
"name": "Company",
"type": "text",
"value": ""
},
{
"name": "Open question",
"type": "text",
"value": ""
},
{
"name": "Select",
"type": "optionId",
"value": null
}
]
}
]
}
],
"payments": [
{
"payment_id": "63206fa6973b861ff8e05230",
"name": "VISA",
"amount_in_cents": 5000,
"is_complimentary": false
}
],
"tags": [
"tag-1"
],
"note": ""
}
]Updated 19 days ago