Confirmation API¶

Overview¶

The Confirmation API handles booking confirmations and related operations within the Gustaffo Reservations system.

Base Path¶

All confirmation endpoints are prefixed with /confirmation

Authentication¶

Confirmation endpoints require appropriate authentication based on the operation being performed.

Confirmation Process¶

The confirmation process follows these steps:

Booking Event: A booking is created, modified, or cancelled
Confirmation Request: System initiates confirmation process
Template Selection: Appropriate confirmation template is selected
Data Population: Booking data is populated into template
Confirmation Generation: Confirmation document is generated
Delivery Method Selection: System selects appropriate delivery method
Confirmation Delivery: Confirmation is delivered to guest
Delivery Tracking: System tracks delivery status
Confirmation Storage: Confirmation is stored for future reference

Endpoints¶

Booking Confirmations¶

Manages the confirmation process for hotel reservations.

Key Operations: - Generate booking confirmations - Send confirmation emails - Retrieve confirmation details - Update confirmation status

Confirmation Processing¶

Handles the processing and delivery of confirmations.

Key Features: - Automated confirmation generation - Multi-channel confirmation delivery - Confirmation tracking and status - Confirmation customization

Confirmation Types¶

Booking Confirmations¶

Initial booking confirmation
Reservation details
Payment information
Check-in instructions

Modification Confirmations¶

Booking change confirmations
Updated reservation details
Price adjustment notifications
New confirmation numbers

Cancellation Confirmations¶

Cancellation acknowledgment
Refund information
Cancellation policy details
Alternative booking suggestions

Business Rules¶

Confirmation Generation¶

Confirmations are generated automatically upon booking
Confirmation numbers are unique and sequential
Confirmation details match booking information
Confirmations are sent to verified contact information

Confirmation Delivery¶

Multiple delivery channels are supported
Delivery failures are retried automatically
Confirmation delivery is tracked
Backup delivery methods are available

Delivery Channels¶

Email Confirmations¶

HTML formatted confirmations
PDF attachment support
Template-based customization
Delivery tracking

SMS Confirmations¶

Brief confirmation messages
Booking reference numbers
Check-in reminders
Important updates

Print Confirmations¶

Formatted confirmation documents
QR code integration
Barcode support
Professional formatting

Integration Points¶

The Confirmation API integrates with: - Booking management systems - Email delivery services - SMS notification services - Template management systems - Print services - QR code generation systems

Error Handling¶

Common error scenarios: - Invalid booking references - Confirmation delivery failures - Template processing errors - Integration service failures - Invalid contact information