Acquisition channel

What is the acquisition channel property, how to use it, how to retrieve it

The "acquisitionChannel" field allows you to track the source of a booking; it's an optional field that can be passed as a string with the booking details during booking creation, either using the booking widget v3 or the booking API.

How to pass the source with the booking details when creating a booking:

• Booking Widget v3
  • See here to understand how to configure the acquisitionChannel property and pass it when creating a booking. 

• Booking API 
  • The acquisitionChannel property can be passed in the body of a POST request. See here for more info.
  • See here for relevant API documentation:

How to retrieve the booking source

The acquisition channel can be found in the following:

• Appointment automated FTP reports
  • *Note: this field is excluded by default (ask your Booxi representative to include it)
• Reservation automated FTP reports
  • *Note: this field is excluded by default (ask your Booxi representative to include it)

• Webhook
  • Included in all appointment and reservation webhook events.
    The “acquisitionChannel” property is at the root of the booking object.

• API
  • The acquisitionChannel property will be returned on any GET Booking API calls returning the bookingId:
    • Get /Booking
    • Get /Booking/{bookingId}
    • Get /Calendar
    • Put /Booking; the acquisitionChannel property is included in the response.
      • The “acquisitionChannel” property is at the root of the booking object.

Limitations

• The booking widget v2 does not support this field; "acquisitionChannel" will be empty for bookings created using BNv2.
• The acquisition channel value is passed during booking creation, and won't be changed when a booking is edited. Will be included in the webhook data for appointment.updated and reservation.updated

Specifications

The acquisitionChannel property string shall comply with the following requirements:

•  64 characters max (truncated if over 64 characters)

• Supports the following characters:
  • Numbers, letters 
  • +-.,_= 

Examples of valid values:

• E-commerce
• Facebook
• Clienteling_app
• Line-chat
• Google_ad-campaign,summer2024