Description

This endpoint can be used to amend a booking in carrier system.

Types of supported amendment operations

The amendment of the following parameters of a booking are supported through the API (subejct to carrier support and policies):

• Origin / destination of the trip
• Date and time of the trip
• Fare class
• Passenger personal information
• Seats
• Adding discount cards, coupons, vouchers
• Adding or removing anciliaries

API workflow

The process of amending a ticket is designed to mimic the regular reservation flow, following the below sequence of steps:

1. Retrieve and display the booking information, including the amendment rules (cutoff, fees, etc.) through /bookings/{booking_id} endpoint.

2. Fetch alternative connections - using /connections/find endpoint while additionally specifying the booking_id of the existing booking as an additional parameter. The API will return all available connections according to provided criteria. In case the amendment is no longer possible as per the carrier’s policies, this request will not return any results.

3. Confirm vacancy of the newly selected trip - using /connections/vacancy endpoint while additionally specifying the existing booking id as a new parameter. The response includes the terms of the amendment and the potential balance to paid for the amendment of the journey (consisting of the difference in fare and a potential amendment fee).

4. Create the amendment using the dedicated /amendments/create endpoint, in which all parameters from the original /reservations/create or /bookings/create can also be specified and thus amended. Parameters that are not being amended can be ommitted from the request and will remain as per the original booking.

5. Once the user has paid the balance, the /amendments/confirm endpoint can be used to trigger the journey modifications in the carrier’s system.

6. Check the /amendments/{amendment_id} endpoint continually every 10 seconds until the state is marked as confirmed.

In cases the customer wants to only change passenger information, steps 2 and 3 are optional.

Agent Portal

Distribusion also provides interfaces through which customer support teams can provide amendment services on behalf of customers.

Note

Please note that this is an enterprise API feature - reach out to your Partnership Manager for more information about unlocking this and other advanced features.

More Info

• Full API Integration
  • Basic workflow
  • Trip search
  • Trip selection and reservation
  • Checkout and trip confirmation
  • Post-booking actions
• Key Concepts
  • Reservations
    • Reservations overview
    • Understanding reservations flow
    • Common pitfalls and errors to avoid
  • Currencies and locales
• Endpoints
  • POST /retailers/v4/amendments/create

Description

This endpoint can be used to confirm an amendment of a booking in carrier system.

API workflow

The process of amending a ticket is designed to mimic the regular reservation flow, following the below sequence of steps:

1. Retrieve and display the booking information, including the amendment rules (cutoff, fees, etc.) through /bookings/{booking_id} endpoint.
2. Fetch alternative connections - using /connections/find endpoint while additionally specifying the booking_id of the existing booking as an additional parameter. The API will return all available connections according to provided criteria. In case the amendment is no longer possible as per the carrier’s policies, this request will not return any results.
3. Confirm vacancy of the newly selected trip - using /connections/vacancy endpoint while additionally specifying the existing booking id as a new parameter. The response includes the terms of the amendment and the potential balance to paid for the amendment of the journey (consisting of the difference in fare and a potential amendment fee).
4. Create the amendment using the dedicated /amendments/create endpoint, in which all parameters from the original /reservations/create or /bookings/create can also be specified and thus amended. Parameters that are not being amended can be ommitted from the request and will remain as per the original booking.
5. Once the user has paid the balance, the /amendments/confirm endpoint can be used to trigger the journey modifications in the carrier’s system.
6. Check the /amendments/{amendment_id} endpoint continually every 10 seconds until the state is marked as confirmed.

In cases the customer wants to only change passenger information, steps 2 and 3 are optional.

Note

Please note that this is an enterprise API feature - reach out to your Partnership Manager for more information about unlocking this and other advanced features.

More Info

• Full API Integration

  • Basic workflow
  • Trip search
  • Trip selection and reservation
  • Checkout and trip confirmation
  • Post-booking actions

• Key Concepts

  • Reservations
    • Reservations overview
    • Understanding reservations flow
    • Common pitfalls and errors to avoid
  • Currencies and locales

• Endpoints

  • PUT /retailers/v4/amendments/confirm

Description

This endpoint can be used to retrieve all details regarding a specific amendment.

API workflow

The process of amending a ticket is designed to mimic the regular reservation flow, following the below sequence of steps:

1. Retrieve and display the booking information, including the amendment rules (cutoff, fees, etc.) through /bookings/{booking_id} endpoint.
2. Fetch alternative connections - using /connections/find endpoint while additionally specifying the booking_id of the existing booking as an additional parameter. The API will return all available connections according to provided criteria. In case the amendment is no longer possible as per the carrier’s policies, this request will not return any results.
3. Confirm vacancy of the newly selected trip - using /connections/vacancy endpoint while additionally specifying the existing booking id as a new parameter. The response includes the terms of the amendment and the potential balance to paid for the amendment of the journey (consisting of the difference in fare and a potential amendment fee).
4. Create the amendment using the dedicated /amendments/create endpoint, in which all parameters from the original /reservations/create or /bookings/create can also be specified and thus amended. Parameters that are not being amended can be ommitted from the request and will remain as per the original booking.
5. Once the user has paid the balance, the /amendments/confirm endpoint can be used to trigger the journey modifications in the carrier’s system.
6. Check the /amendments/{amendment_id} endpoint continually every 10 seconds until the state is marked as confirmed.

In cases the customer wants to only change passenger information, steps 2 and 3 are optional.

How it works

The current status of an amendment can be checked using the /amendments/{amendment_id} endpoint.

In the response, the value state shows the current state of the reservation. Values can be:

• created: The default value, appears right after the amendment is created.
• processing: Shown after /amendments/confirm is initially called.
• confirmed: Shown once the amendment is confirmed with the carrier.
• cancelled: Shows after the user leaves the page and /reservations/cancelled is called.
• failed: Shown if something went wrong in the booking.

Processing deadline

In the response, the processing_deadline value will present the date and time that the retailer should request /amendments/{amendment_id} to see if a booking was successfully created. Hence if you stop listening to it before that time frame, a discrepancy can happen.

The reservation status must be continually checked every 10 seconds until one of the following occurs:

• The amendment is confirmed and you can proceed with the post-booking actions.
• The amendment times out, in which case it will be automatically tagged as failed.
• The amendment fails, in which case the user must be notified that their booking was unsuccessful.

Important

The typical processing deadline is 10 mins and it is essential to continue listening (calling /amendments/{amendment_id}) until the deadline expires. If you stop listening before processing_deadline reaches 0 and then the booking is created, there will be a discrepancy in status of the booking between you and the carrier. If this occurs, you will still be charged and incur the transaction costs.

Note

Please note that this is an enterprise API feature - reach out to your Partnership Manager for more information about unlocking this and other advanced features.

More Info

• Full API Integration

  • Basic workflow
  • Trip search
  • Trip selection and reservation
  • Checkout and trip confirmation
  • Post-booking actions

• Key Concepts

  • Reservations
    • Reservations overview
    • Understanding reservations flow
    • Common pitfalls and errors to avoid
  • Currencies and locales

• Endpoints

  • GET /retailers/v4/amendments/{amendment_id}