Bookings
Get bookings
GET /api/internal/v1/partners/:partner_id/bookings
Path Parameters
partner_id
integer
The ID of the partner.
Query Parameters
from_start_date
string
Return bookings with a start date >= given date. Format: Y-m-d
until_start_date
string
Return bookings with a start date <= given date. Format: Y-m-d
start_date
string
Filter bookings by the start date. Format: Y-m-d
venue_id
integer
Filter bookings by venue ID.
page
number
The page to return.
per_page
number
The number of records to return per page.
Get booking
GET /api/internal/v1/partners/:partner_id/bookings/:booking_id
Get the given booking.
Path Parameters
partner_id
integer
The ID of the partner.
booking_id
integer
The ID of the booking.
Create venue booking
POST /api/internal/v1/partners/:partner_id/bookings/venues
Create a main booking with one or many venue bookings attached.
Path Parameters
partner_id
integer
The ID of the partner.
Request Body
customer_id
integer
payment_type_id
integer
internal_note
string
venues.*.venue_id
integer
The ID of the booked venue.
venues.*.discount_id
integer
The ID of the discount, if any.
venues.*.places_used
number
Number of places occupied.
venues.*.starts_at
string
When the booking starts. Y-m-d H:i:s
venues.*.ends_at
string
When the booking ends. Y-m-d H:i:s
venues.*.use_manual_proice
boolean
Indicate if a manual price should be used.
venues.*.manual_price_vat_id
integer
The VAT ID to be applied to the manual price.
venues.*.manual_price_amount_gross
string
The gross amount of the manual price.
Get event bookings
GET /api/internal/v1/partners/:partner_id/bookings/events
Path Parameters
partner_id
integer
Create event booking
POST /api/internal/v1/partners/:partner_id/bookings/events
Path Parameters
partner_id
integer
Request Body
customer_id
integer
payment_type_id
integer
internal_note
string
events
array
events.*.event_id
integer
events.*.use_manual_price
boolean
events.*.price_id
integer
Required if a manual price is not used.
events.*.discount_id
integer
events.*.manual_price_vat_id
integer
Required if a manual price is used.
events.*.manual_price_amount_gross
number
Required if a manual price is used.
Get event booking
GET /api/internal/v1/partners/:partner_id/bookings/events/:event_booking_id
Path Parameters
event_booking_id
integer
The ID of the event booking.
partner_id
integer
The ID of the partner.
Update event booking
PUT /api/internal/v1/partners/:partner_id/bookings/events/:event_booking_id
Update a single EventBooking.
Path Parameters
partner_id
integer
event_booking_id
string
Request Body
customer_id
integer
payment_type_id
integer
internal_note
string
event_id
integer
use_manual_price
boolean
price_id
integer
Required if a manual price is not used.
discount_id
integer
manual_price_vat_id
integer
Required if a manual price is used.
manual_price_amount_gross
number
Require if a manual price is used
Get inventory product bookings
GET /api/internal/v1/partners/:partner_id/bookings/inventory-products
Path Parameters
partner_id
integer
The ID of the partner.
Query Parameters
page
integer
The current page number.
per_page
integer
search
string
Filter results by customer or inventory product name.
inventory_product_facility_id
integer
Not implemented yet.
booking_start_date
string
Not implemented yet. Format: Y-m-d
booking_end_date
string
Not implemented yet. Format: Y-m-d
customer_organization_type
string
Not implemented yet.
customer_organization_id
integer
Not implemented yet.
customer_group_id
integer
Not implemented yet.
booking_statuses
array
Not implemented yet. Filter by booking statuses.
inventory_product_id
integer
Not implemented yet.
Get inventory product booking
GET /api/internal/v1/partners/:partner_id/bookings/inventory-products/:inventory_product_booking_id
Get the given inventory product booking.
Path Parameters
partner_id
integer
The ID of the partner.
inventory_product_boking_id
integer
The ID of the inventory product booking.
Create inventory product booking
POST /api/internal/v1/partners/:partner_id/bookings/inventory-products
Path Parameters
partner_id
integer
The ID of the partner.
Request Body
customer_id
integer
The ID of the customer who is booking.
payment_type_id
integer
The ID of the payment type.
internal_note
string
Booking internal note.
inventory_products.*.inventory_product_id
integer
The ID of the inventory product that will be booked.
inventory_products.*.discount_id
integer
The ID of the discount to apply. Ignored when a manual price is used.
inventory_products.*.units
number
The number of inventory products booked.
inventory_products.*.starts_at
string
Date-time (Y-m-d H:i:s) when the booking of the product starts.
inventory_products.*.ends_at
string
Date-time (Y-m-d H:i:s) when the booking of the product ends.
inventory_products.*.use_manual_price
boolean
Indicate if a manual price should be used.
inventory_products.*.manual_price_amount_gross
number
The gross amount of the manual price.
inventory_products.*.manual_price_vat_id
integer
The ID of the VAT to use for the manual price.
Update inventory product booking
PUT /api/internal/v1/partners/:partner_id/bookings/inventory-products/:inventory_product_booking_id
Path Parameters
partner_id
integer
The ID of the partner.
inventory_product_booking_id
integer
The ID of the inventory product booking.
Request Body
customer_id
integer
payment_type_id
integer
internal_note
string
inventory_product_id
integer
discount_id
integer
units
integer
starts_at
string
ends_at
string
use_manual_price
boolean
manual_price_vat_id
integer
manual_price_amount_gross
number
Cancel booking
DELETE /api/internal/v1/partners/:partner_id/bookings/:booking_id
Path Parameters
partner_id
integer
The ID of the partner.
booking_id
integer
The ID of the booking.
Get booking statuses
GET /api/internal/v1/partners/:partner_id/bookings/statuses
Get all the available booking statuses.
Path Parameters
partner_id
number
The ID of the partner.
Last updated
Was this helpful?