Skip to content

Bookings

Returns list of bookings in the system. Returned data can be limited with start and end query parameters.

Operations

Download bookings as JSON

Request

GET https://api.zoined.com/v2/download/bookings.json?limit=1000&offset=0&start=2021-01-01&end=2021-01-31

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
startstring

Return data starting from given date

Example:start=2021-01-01
endstring

Return data ending to given date

Example:end=2021-01-31
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/bookings.json?limit=1000&offset=0&start=2021-01-01&end=2021-01-31' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
booking_idstringrequired

Unique ID for the booking

Example:"er/232/f31"
booking_line_idstringrequired

Secondary booking identifier

Example:"1"
customer_idstring

Customer ID for identified customer

Example:"32"
product_idstringrequired

Product ID

Example:"XYZ"
event_idstring

A (string, optional) - Optional ID for the event this booking is done for.

Example:"123"
organisation_idstringrequired

Organisation unit ID

Example:"540"
department_idstring

Department ID

Example:"54011"
salesperson_idstring

Sales person ID

Example:"5402101"
booked_quantitynumberrequired

Booked quantity

Example:2
number_of_guestsnumber

Number of guests booked

Example:2
number_of_visitsnumber

Number of visits allowed per guest within start and end dates.

Example:2
sales_valuenumberrequired

Total booking sales amount including tax

Example:20
sales_value_wo_vatnumber

Total booking sales amount without tax

Example:20
currencystring

Currency as ISO 4217 currency code. Required if multiple currencies are used.

Example:"EUR"
canceledboolean

True when this booking has been cancelled.

Example:false
booking_datestringrequired

Booking date (yyyy-mm-dd)

Example:"2020-03-01"
booking_timestring

Booking time (HH:mm:ss)

Example:"15:00:00"
event_start_datestringrequired

Event start date (yyyy-mm-dd)

Example:"2020-03-10"
event_start_timestring

Event start time (HH:mm:ss)

Example:"15:00:00"
event_end_datestring

Event end date (yyyy-mm-dd)

Example:"2020-03-11"
event_end_timestring

Event end time (HH:mm:ss)

Example:"15:00:00"
booking_typestringrequired

Booking type. Must be either event, ticket or room.

Example:"event"
custom_field_1string

Custom field 1

Example:"EU only"
custom_field_2string

Custom field 2

Example:"EU only"
custom_field_3string

Custom field 3

Example:"EU only"
custom_field_4string

Custom field 4

Example:"EU only"
custom_field_5string

Custom field 5

Example:"EU only"
custom_metric_1number

Custom metric 1

Example:1
custom_metric_2number

Custom metric 2

Example:100
custom_metric_3number

Custom metric 3

Example:2.2
custom_metric_4number

Custom metric 4

Example:1.05
custom_metric_5number

Custom metric 5

Example:10000
Response
{
  "booking_id": "er/232/f31",
  "booking_line_id": "1",
  "customer_id": "32",
  "product_id": "XYZ",
  "event_id": "123",
  "organisation_id": "540",
  "department_id": "54011",
  "salesperson_id": "5402101",
  "booked_quantity": 2,
  "number_of_guests": 2,
  "number_of_visits": 2,
  "sales_value": 20,
  "sales_value_wo_vat": 20,
  "currency": "EUR",
  "canceled": false,
  "booking_date": "2020-03-01",
  "booking_time": "15:00:00",
  "event_start_date": "2020-03-10",
  "event_start_time": "15:00:00",
  "event_end_date": "2020-03-11",
  "event_end_time": "15:00:00",
  "booking_type": "event",
  "custom_field_1": "EU only",
  "custom_field_2": "EU only",
  "custom_field_3": "EU only",
  "custom_field_4": "EU only",
  "custom_field_5": "EU only",
  "custom_metric_1": 1,
  "custom_metric_2": 100,
  "custom_metric_3": 2.2,
  "custom_metric_4": 1.05,
  "custom_metric_5": 10000
}