Example of Reservation JSON Data Sent by Webhook

Below is an example of the reservation JSON data sent to a user-defined endpoint as a result of the reservation.create webhook trigger: 

{
"reference":"Jun0006-24",
"data":{
"reference":"Jun0006-24",
"stage":"provisional",
"status":"ok",
"draft":false,
"notes":[],
"extras":[],
"items":[
{
"id":0000000000,
"size":"10",
"name":"Item",
"status":"ready",
"items":[],
"issues":[],
"extras":[],
"context":{},
"item_id":445,
"item_search_term":null,
"store_ref":"Item3",
"category_id":"00000000001",
"lock_code":null,
"client_id":null,
"notes":null,
"product_family_id":000000000002,
"product_line_id":000000,
"price":10.00,
"price_overridden":false,
"home_location":null,
"current_location":null,
"service_points":0,
"safety_checked":false,
"inventory_type":"item",
"parent_id":null,
"checkin_notes":null,
"checkin_broken":false,
"has_issues":null,
"actual_checkin_ts":null,
"actual_checkout_ts":null,
"created_ts":1717507195418,
"created_user_id":0000000001,
"updated_ts":null,
"updated_user_id":null,
"tax_code":{"rate":"20","name":"Default",
"description":"Default sales tax for the store",
"id":1
}}],"channel":"brm2",
"issues":[],
"context":{},
"stripeLinked":true,
"reservation_type_id":1,
"group_name":null,
"group":null,
"group_id":null,
"start_date":"2024-06-04",
"end_date":"2024-06-04",
"start_time":"12:00",
"end_time":"13:00",
"booking_language":"en",
"customer_id":1,
"customer_first_name":"Test",
"customer_last_name":"Test",
"customer_phone_number":"",
"customer_stripe_id":"xxxxxxxx",
"customer_signature_ts":null,
"customer_email":"brm@email.com",
"tax_model":"tax_inclusive",
"total_price":10.00,
"total_tax":1.67,
"total_discount":0.00,
"total_received":0.00,
"sub_total":10.00,
"discounted_subtotal":10.00,
"balance":10.00,
"invoice_number":null,
"discount":0.00,
"discount_code":null,
"pricing_type":"detail_up_auto",
"item_count":1,
"has_notes":false,
"has_extras":false,
"has_generic_items":false,
"has_delivery":false,
"delivery_notes":null,
"delivery_time":null,
"is_stripe_linked":true,
"actual_checkin_ts":null,
"actual_checkout_ts":null,
"just_do_it":false,
"tax_lines":[],
"billable_days":-1,
"overridden_billable_days":null,
"delivery_price":null,
"delivery_tax":null,
"pickup_price":null,
"pickup_tax":null,
"start_location":"",
"end_location":"",
"referrer":null,
"security_deposit_notes":null,
"security_deposit_amount":0.00,
"security_deposit_returned":false,
"delivery_slot_id":null,
"pickup_slot_id":null,
"pickup_address":null,
"delivery_address":null,
"delivery_address_id":null,
"pickup_address_id":null,
"has_issues":null,
"documents":[],
"customer_marketing_opt_in":false,
"created_ts":1717507195418,
"created_user_id":00000001,
"updated_ts":1717507195647,
"updated_user_id":0000000001},
"namespace":"yourstore",
"event":"reservation.create"}

Key Fields:

• reference: The unique identifier for the reservation.

• stage: Indicates whether the booking is in "provisional" or "confirmed" state.

• status: The current status of the reservation (e.g., "ok").

• items: List of items associated with the reservation, including pricing, inventory, and tax information.

• customer details: Contains the customer’s name, email, phone number, and Stripe ID.

• total price and taxes: Includes the total price, taxes, and any discounts applied to the reservation.

This data is sent when the reservation.create event is triggered, and can be used for further processing or integration with other systems.