List of Ticket-Orders

GET https://api.e-guma.ch/v1/ticketing/orders.json?apikey={api-key}

Parameters

api-key
required
updated_at_afterShow orders modified at or after date (format: 2019-06-04T23:15:14).
updated_at_beforeShow orders modified before date (format: 2019-07-04T23:15:14).
order_numberThe sequential number of the order, eg. 1000001.
last_nameThe last name of the person associated with the order. It is case sensitive.

Return

idThe 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
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.
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

idThe ID of the customer.
titleMr, Mrs or Company
first_nameFirst name
last_nameLast name
companyCompany name
streetStreet
zipZip code
cityCity
countryCountry as two-letter code (ISO 3166-1 alpha-2)
emailEmail address
accepts_marketingWhether the customer consented (Double Opt-in) to receive email newsletters.
double_opt_in_confirmed_atIf 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.
phonePhone number

Order line object

product_idThe ID of the product.
nameThe name of the event or admission (e.g. Magical Brunch).
starts_atDate and time (ISO 8601 format) when the event occurs. This value is null for admission-tickets without a start date.
ticket_type_idThe id of the ticket type
ticket_type_nameThe name of the ticket type (e.g. Normal price)
quantityQuantity
total_price_in_centsquantity x unit_price_in_cents

Payment object

payment_idThe ID of the payment method.
nameThe name of the payment method. E.g. Credit Card
amount_in_centsAmount
is_complimentaryIndicates if a payment is complimentary.

Example

GET https://api.e-guma.ch/v1/ticketing/orders.json?updated_at_after=2019-07-29T00:00:00&apikey=5bb668e394f2811f3ca4a9db
[
  {
    "id": "5f368a22bfedea3fc4b6415a",
    "created_at": "2020-08-14T14:57:06",
    "updated_at": "2020-08-14T14:57:06",
    "order_number": "1000033",
    "status": "completed",
    "currency": "CHF",
    "language": "de",
    "location": "local",
    "discount_in_cents": 1000,
    "grand_total_in_cents": 9000,
    "customer": {
      "id": "0b805b90-ad5d-4cef-a02c-bb63e5c794b3",
      "title": "Mr",
      "first_name": "Daniel",
      "last_name": "Thomet",
      "company": "Idea Creation GmbH",
      "street": "Walchestrasse 15",
      "zip": "8006",
      "city": "Zürich",
      "country": "CH",
      "email": "[email protected]",
      "accepts_marketing": true,
      "double_opt_in_confirmed_at": "2020-08-13T14:30:20",
      "phone": "044 500 54 03"
    },
    "order_lines": [
      {
        "product_id": "5f3689ccbfedea3fc4b64156",
        "name": "Magical Brunch",
        "starts_at": "2020-09-06T10:00:00",
        "ticket_type_id": "81d0bd03-dd51-403d-a8d9-8dfe1eaf58e4",
        "ticket_type_name": "Normal price",
        "unit_price_in_cents": 5000,
        "quantity": 2,
        "total_price_in_cents": 10000
      }
    ],
    "payments": [
      {
        "payment_id": "5586faee94f28723b4137c4a",
        "name": "Cash",
        "amount_in_cents": 9000,
        "is_complimentary": false
      }
    ]
  }
]