Appearance

Get Bookings ​

GET
/v1/octo/bookings

Get all bookings for the authenticated client

Authorizations​

Parameters​

Query Parameters

resellerReference

Filter by reseller reference

Default
null
supplierReference

Filter by supplier reference

Default
null
localDate

Filter bookings for events on this date (YYYY-MM-DD)

Default
null
localDateStart

Filter bookings for events from this date (YYYY-MM-DD)

Default
null
localDateEnd

Filter bookings for events up to this date (YYYY-MM-DD)

Default
null
productId

Filter by product identifier

Default
null
optionId

Filter by option identifier

Default
null

Responses​

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"uuid": "string",
  
  
"resellerReference": null,
  
  
"supplierReference": "string",
  
  
"status": "string",
  
  
"testMode": true,
  
  
"cancellable": true,
  
  
"freesale": true,
  
  
"utcCreatedAt": "string",
  
  
"utcUpdatedAt": null,
  
  
"utcExpiresAt": null,
  
  
"utcRedeemedAt": null,
  
  
"utcConfirmedAt": null,
  
  
"utcCancelledAt": null,
  
  
"productId": "string",
  
  
"product": {
  
  
  
"id": "string",
  
  
  
"internalName": "string",
  
  
  
"reference": "string",
  
  
  
"locale": "string",
  
  
  
"timeZone": null,
  
  
  
"allowFreesale": true,
  
  
  
"instantConfirmation": true,
  
  
  
"instantDelivery": true,
  
  
  
"availabilityRequired": true,
  
  
  
"availabilityType": "string",
  
  
  
"deliveryFormats": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"deliveryMethods": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"redemptionMethod": "string",
  
  
  
"options": [
  
  
  
  
{
  
  
  
  
  
"id": "string",
  
  
  
  
  
"default": true,
  
  
  
  
  
"internalName": "string",
  
  
  
  
  
"reference": "string",
  
  
  
  
  
"availabilityLocalStartTimes": [
  
  
  
  
  
  
"string"
  
  
  
  
  
],
  
  
  
  
  
"cancellationCutoff": "string",
  
  
  
  
  
"cancellationCutoffAmount": 0,
  
  
  
  
  
"cancellationCutoffUnit": "string",
  
  
  
  
  
"requiredContactFields": [
  
  
  
  
  
  
"string"
  
  
  
  
  
],
  
  
  
  
  
"restrictions": {
  
  
  
  
  
  
"minUnits": 1,
  
  
  
  
  
  
"maxUnits": 10
  
  
  
  
  
},
  
  
  
  
  
"units": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"id": "string",
  
  
  
  
  
  
  
"internalName": "string",
  
  
  
  
  
  
  
"reference": null,
  
  
  
  
  
  
  
"type": "string",
  
  
  
  
  
  
  
"restrictions": {
  
  
  
  
  
  
  
  
"minAge": 18,
  
  
  
  
  
  
  
  
"maxAge": 99,
  
  
  
  
  
  
  
  
"idRequired": false,
  
  
  
  
  
  
  
  
"minQuantity": 1,
  
  
  
  
  
  
  
  
"maxQuantity": 10,
  
  
  
  
  
  
  
  
"paxCount": 1,
  
  
  
  
  
  
  
  
"accompaniedBy": [
  
  
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
  
  
]
  
  
  
  
  
  
  
},
  
  
  
  
  
  
  
"requiredContactFields": [
  
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
  
],
  
  
  
  
  
  
  
"pricingFrom": [
  
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
  
"original": null,
  
  
  
  
  
  
  
  
  
"retail": null,
  
  
  
  
  
  
  
  
  
"net": null,
  
  
  
  
  
  
  
  
  
"currency": "string",
  
  
  
  
  
  
  
  
  
"currencyPrecision": 2,
  
  
  
  
  
  
  
  
  
"includedTaxes": [
  
  
  
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
  
  
  
  
}
  
  
  
  
  
  
  
  
  
]
  
  
  
  
  
  
  
  
}
  
  
  
  
  
  
  
]
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
],
  
  
  
"defaultCurrency": "string",
  
  
  
"availableCurrencies": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"pricingPer": "string"
  
  
},
  
  
"optionId": "string",
  
  
"option": {
  
  
  
"id": "string",
  
  
  
"default": true,
  
  
  
"internalName": "string",
  
  
  
"reference": "string",
  
  
  
"availabilityLocalStartTimes": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"cancellationCutoff": "string",
  
  
  
"cancellationCutoffAmount": 0,
  
  
  
"cancellationCutoffUnit": "string",
  
  
  
"requiredContactFields": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"restrictions": {
  
  
  
  
"minUnits": 1,
  
  
  
  
"maxUnits": 10
  
  
  
},
  
  
  
"units": [
  
  
  
  
{
  
  
  
  
  
"id": "string",
  
  
  
  
  
"internalName": "string",
  
  
  
  
  
"reference": null,
  
  
  
  
  
"type": "string",
  
  
  
  
  
"restrictions": {
  
  
  
  
  
  
"minAge": 18,
  
  
  
  
  
  
"maxAge": 99,
  
  
  
  
  
  
"idRequired": false,
  
  
  
  
  
  
"minQuantity": 1,
  
  
  
  
  
  
"maxQuantity": 10,
  
  
  
  
  
  
"paxCount": 1,
  
  
  
  
  
  
"accompaniedBy": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
]
  
  
  
  
  
},
  
  
  
  
  
"requiredContactFields": [
  
  
  
  
  
  
"string"
  
  
  
  
  
],
  
  
  
  
  
"pricingFrom": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"original": null,
  
  
  
  
  
  
  
"retail": null,
  
  
  
  
  
  
  
"net": null,
  
  
  
  
  
  
  
"currency": "string",
  
  
  
  
  
  
  
"currencyPrecision": 2,
  
  
  
  
  
  
  
"includedTaxes": [
  
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
  
  
  
}
  
  
  
  
  
  
  
]
  
  
  
  
  
  
}
  
  
  
  
  
]
  
  
  
  
}
  
  
  
]
  
  
},
  
  
"availabilityId": "string",
  
  
"availability": {
  
  
  
"id": "string",
  
  
  
"localDateTimeStart": "string",
  
  
  
"localDateTimeEnd": "string",
  
  
  
"allDay": true
  
  
},
  
  
"contact": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"notes": "",
  
  
"cancellation": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"unitItems": [
  
  
  
{
  
  
  
  
"uuid": null,
  
  
  
  
"unitId": "string",
  
  
  
  
"status": "string",
  
  
  
  
"resellerReference": null,
  
  
  
  
"utcRedeemedAt": null,
  
  
  
  
"ticket": {
  
  
  
  
  
"redemptionMethod": "DIGITAL",
  
  
  
  
  
"deliveryOptions": [
  
  
  
  
  
  
{
  
  
  
  
  
  
  
"deliveryFormat": "PDF_URL",
  
  
  
  
  
  
  
"deliveryValue": ""
  
  
  
  
  
  
}
  
  
  
  
  
],
  
  
  
  
  
"utcRedeemedAt": null
  
  
  
  
},
  
  
  
  
"contact": {
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
}
  
  
  
}
  
  
],
  
  
"pricing": {
  
  
  
"original": null,
  
  
  
"retail": null,
  
  
  
"net": null,
  
  
  
"currency": "string",
  
  
  
"currencyPrecision": 2,
  
  
  
"includedTaxes": [
  
  
  
  
{
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
}
  
  
  
]
  
  
},
  
  
"deliveryMethods": [
  
  
  
"string"
  
  
],
  
  
"voucher": {
  
  
  
"redemptionMethod": "DIGITAL",
  
  
  
"deliveryOptions": [
  
  
  
  
{
  
  
  
  
  
"deliveryFormat": "PDF_URL",
  
  
  
  
  
"deliveryValue": ""
  
  
  
  
}
  
  
  
],
  
  
  
"utcRedeemedAt": null
  
  
}
  
}
]

Playground​

Server
Variables
Key
Value

Samples​