Amendments
Another common form of post-booking functionality is the amendment of a trip by a customer.
Types of Amendment Supported
The amendment of the following parameters of a booking are supported through the API (subject 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 ancillaries
API Workflow
The process of amending a ticket is designed to mimic the regular reservation flow, following the below sequence of steps:
- Retrieve and display the booking information, including the amendment rules from
post_booking_rules(cutoff, fees, etc.) through the /bookings/{booking_id}/conditions endpoint. - Display the list of allowed amendments to the user in your UI and limit the functionality to only support the amendments allowed.
- In case user wants to change their trip details (fare class, departure time or dates) fetch alternative connections using /connections/find endpoint while additionally specifying the
booking_idof the existing booking as an additional parameter. - The API will return all available connections according to provided criteria. The prices in the response will be adjusted considering the amount of the original booking and possible penalties. In case the amendment is no longer possible as per the carrier’s policies, this request will not return any results.
- Confirm vacancy of the newly selected trip using /connections/vacancy endpoint while additionally specifying the existing
booking idas a new parameter. The response includes the terms of the amendment and the potential balance to be paid for the amendment of the journey (consisting of the difference in fare and a potential amendment fee). - Create the amendment using the dedicated /amendments/create endpoint, in which all parameters from the original /reservations/create request can also be specified and thus amended. Parameters that are not being amended can be omitted from the request and will remain as per the original booking.
- If the price of the new trip is higher the user has to pay the balance, but if the new trip is cheaper you have to refund the difference to the user.
- Use the /amendments/confirm endpoint can be used to trigger the journey modifications in the carrier’s system.
- The amendment status must be continually checked using the /amendments/{amendment_id} endpoint (similar to how it works in the Checking Reservation Status step) until one of the following occurs: the amendment is
confirmedorfailed. - After the amendments is confirmed, the /amendments/{amendment_id} endpoint will show 2 booking IDs. The
amended_bookingsection shows theidof the original booking that was amended. This booking remains unchanged except for the new statusamended. Thebookingsection shows theidof the new booking created in the carrier system. This is the one that shows the new details. Note that for every additional amendment a new booking is created.
Distribusion also provides interfaces through which customer support teams can provide amendment services on behalf of customers. Check our Agency Counter guide for more details about how it works.
API Examples
Sample Request to /bookings/{booking_id}/conditions
HTTP
https://api.demo.distribusion.com/retailers/v4/bookings/WIXZu9HfZePYVd_4-lMS-Q/conditionsSample Response from /bookings/{booking_id}/conditions
JSON
{
"data": {
"id": "COND-STES-WIXZu9HfZePYVd_4-lMS-Q",
"type": "booking_conditions",
"relationships": {
"amendment_condition": {
"data": {
"id": "AMND-COND-STES-WIXZu9HfZePYVd_4-lMS-Q",
"type": "amendment_conditions"
}
}
}
},
"jsonapi": {
"version": "1.0"
},
"meta": {
"currency": "EUR"
},
"included": [
{
"id": "AMND-COND-STES-WIXZu9HfZePYVd_4-lMS-Q",
"type": "amendment_conditions",
"attributes": {
"refund_type": "none"
},
"relationships": {
"rules": {
"data": [
{
"id": "AMND-RULE-STES-PBC-TVUU-PBR-KOGV-WIXZu9HfZePYVd_4-lMS-Q",
"type": "amendment_rules"
},
{
"id": "AMND-RULE-STES-PBC-TVUU-PBR-NJGE-WIXZu9HfZePYVd_4-lMS-Q",
"type": "amendment_rules"
},
{
"id": "AMND-RULE-STES-PBC-TVUU-PBR-RODZ-WIXZu9HfZePYVd_4-lMS-Q",
"type": "amendment_rules"
},
{
"id": "AMND-RULE-STES-PBC-TVUU-PBR-XAQT-WIXZu9HfZePYVd_4-lMS-Q",
"type": "amendment_rules"
}
]
}
}
},
{
"id": "AMND-RULE-STES-PBC-TVUU-PBR-KOGV-WIXZu9HfZePYVd_4-lMS-Q",
"type": "amendment_rules",
"attributes": {
"rule_type_identifier": "fare_class_amendment",
"description": "Fare class is amendable",
"allowed": true,
"cutoff": "2024-09-11T21:11",
"fee": 0
}
},
{
"id": "AMND-RULE-STES-PBC-TVUU-PBR-NJGE-WIXZu9HfZePYVd_4-lMS-Q",
"type": "amendment_rules",
"attributes": {
"rule_type_identifier": "general_amendment",
"description": "Amendment allowed",
"allowed": true,
"cutoff": "2024-09-11T21:11",
"fee": 0
}
},
{
"id": "AMND-RULE-STES-PBC-TVUU-PBR-RODZ-WIXZu9HfZePYVd_4-lMS-Q",
"type": "amendment_rules",
"attributes": {
"rule_type_identifier": "date_time_amendment",
"description": "Date and time are amendable",
"allowed": true,
"cutoff": "2024-09-11T21:11",
"fee": 0
}
},
{
"id": "AMND-RULE-STES-PBC-TVUU-PBR-XAQT-WIXZu9HfZePYVd_4-lMS-Q",
"type": "amendment_rules",
"attributes": {
"rule_type_identifier": "origin_destination_amendment",
"description": "Origin and Destination are amendable",
"allowed": true,
"cutoff": "2024-09-11T21:11",
"fee": 0
}
}
]
}For more samples responses, check the /bookings/{booking_id}/conditions endpoint page.
Sample Request to /connections/find
HTTP
https://api.demo.distribusion.com/retailers/v4/connections/find?locale=en¤cy=EUR&departure_stations[]=FRPARPGN&arrival_stations[]=GBLONLIB&departure_date=2024-09-11&departure_start_time=21:00&passengers[][pax]=1&passengers[][max_age]=30&booking_id=WIXZu9HfZePYVd_4-lMS-QSample Response from /connections/find
JSON
{
"data": [
{
"attributes": {
"arrival_time": "2024-09-22T22:30",
"booked_out": false,
"cheapest_fare_class_code": "FARE-5",
"cheapest_total_adult_price": -35800,
"departure_time": "2024-09-22T21:11",
"duration": 8340,
"electronic_ticket_available": false,
"offer_bundle": null,
"offer_id": null,
"total_seats_left": null
},
"id": "STES-FRPARPGN-GBLONLIB-2024-09-22T21:11-2024-09-22T22:30",
"relationships": {
"arrival_station": {
"data": {
"id": "GBLONLIB",
"type": "stations"
}
},
"departure_station": {
"data": {
"id": "FRPARPGN",
"type": "stations"
}
},
"fares": {
"data": [
{
"fare_class": {
"code": "FARE-2",
"id": "STES-FARE-2",
"type": "fare_classes"
},
"id": "STES-FRPARPGN-GBLONLIB-2024-09-22T21:11-2024-09-22T22:30-FARE-2",
"original_price": -30600,
"price": -30600,
"type": "fares"
},
{
"fare_class": {
"code": "FARE-5",
"id": "STES-FARE-5",
"type": "fare_classes"
},
"id": "STES-FRPARPGN-GBLONLIB-2024-09-22T21:11-2024-09-22T22:30-FARE-5",
"original_price": -35800,
"price": -35800,
"type": "fares"
},
{
"fare_class": {
"code": "FARE-1",
"id": "STES-FARE-1",
"type": "fare_classes"
},
"id": "STES-FRPARPGN-GBLONLIB-2024-09-22T21:11-2024-09-22T22:30-FARE-1",
"original_price": 0,
"price": 0,
"type": "fares"
}
]
},
"marketing_carrier": {
"data": {
"id": "STES",
"type": "marketing_carriers"
}
},
"segments": {
"data": [
{
"id": "STES-FRPARPGN-GBLONLIB-2024-09-22T21:11-2024-09-22T22:30-0",
"type": "segments"
}
]
}
},
"type": "connections"
}
],
"included": [
{
"attributes": {
"arrival_time": "2024-09-22T22:30",
"departure_time": "2024-09-22T21:11",
"index": 0,
"line": "9063",
"line_prefix": "EUROSTAR"
},
"id": "STES-FRPARPGN-GBLONLIB-2024-09-22T21:11-2024-09-22T22:30-0",
"relationships": {
"amenities": {
"data": [
{
"id": "EURS-AAFR",
"type": "amenities"
}
]
},
"arrival_station": {
"data": {
"id": "GBLONLIB",
"type": "stations"
}
},
"departure_station": {
"data": {
"id": "FRPARPGN",
"type": "stations"
}
},
"fares": {
"data": []
},
"marketing_carrier": {
"data": {
"id": "STES",
"type": "marketing_carriers"
}
},
"operating_carrier": {
"data": {
"id": "EURS",
"type": "operating_carriers"
}
},
"vehicle": {
"data": {
"id": "TRAIN-STES-FRPARPGN-GBLONLIB-2024-09-22T21:11-2024-09-22T22:30-0",
"type": "vehicles"
}
}
},
"type": "segments"
},
{
"id": "TRAIN-STES-FRPARPGN-GBLONLIB-2024-09-22T21:11-2024-09-22T22:30-0",
"relationships": {
"vehicle_type": {
"data": {
"id": "TRAIN",
"type": "vehicle_types"
}
}
},
"type": "vehicles"
},
{
"attributes": {
"code": "TRAIN"
},
"id": "TRAIN",
"type": "vehicle_types"
},
{
"attributes": {
"booked_out": false,
"original_price": -30600,
"price": -30600,
"seats_left": 19
},
"id": "STES-FRPARPGN-GBLONLIB-2024-09-22T21:11-2024-09-22T22:30-FARE-2",
"relationships": {
"applied_cards": {
"data": []
},
"conditions": {
"data": [
{
"id": "STES-03a55c808dd6e7b9c-5f4c902bb78a8759d",
"type": "fare_conditions"
}
]
},
"fare_class": {
"data": {
"id": "STES-FARE-2",
"type": "fare_classes"
}
}
},
"type": "fares"
},
{
"attributes": {
"booked_out": false,
"original_price": -35800,
"price": -35800,
"seats_left": 59
},
"id": "STES-FRPARPGN-GBLONLIB-2024-09-22T21:11-2024-09-22T22:30-FARE-5",
"relationships": {
"applied_cards": {
"data": []
},
"conditions": {
"data": [
{
"id": "STES-540cb2b6316b11381-6474e4598dadddb51",
"type": "fare_conditions"
}
]
},
"fare_class": {
"data": {
"id": "STES-FARE-5",
"type": "fare_classes"
}
}
},
"type": "fares"
},
{
"attributes": {
"booked_out": false,
"original_price": 0,
"price": 0,
"seats_left": 76
},
"id": "STES-FRPARPGN-GBLONLIB-2024-09-22T21:11-2024-09-22T22:30-FARE-1",
"relationships": {
"applied_cards": {
"data": []
},
"conditions": {
"data": [
{
"id": "STES-ce7c60065442a2ef1-9276c7e5acb395caf",
"type": "fare_conditions"
}
]
},
"fare_class": {
"data": {
"id": "STES-FARE-1",
"type": "fare_classes"
}
}
},
"type": "fares"
},
{
"attributes": {
"code": "ESC_H19PSXASBEX_1",
"description": "Paris Gare du Nord - London St Pancras Int'l - Public Standard Premier Semi-Flex\nExchange without a fee 1 hour before original departure time. If new ticket is more expensive, you’ll pay the difference. If new ticket is cheaper, the difference will not be refunded. Refundable with a €25/£25/$40 fee per person per leg up to 7 days before the departure date. Tickets exchanged less than 7 days before the departure date will become non-refundable.\n",
"title": "Public Standard Premier Semi-Flex"
},
"id": "STES-03a55c808dd6e7b9c-5f4c902bb78a8759d",
"type": "fare_conditions"
},
{
"attributes": {
"code": "ESC_B18PSXASBEX_1",
"description": "Paris Gare du Nord - London St Pancras Int'l - Public Standard Semi-Flex\nExchange without a fee 1 hour before original departure time. If new ticket is more expensive, you’ll pay the difference. If new ticket is cheaper, the difference will not be refunded. Refundable with a €25/£25/$40 fee per person per leg up to 7 days before the departure date. Tickets exchanged less than 7 days before the departure date will become non-refundable.\n",
"title": "Public Standard Semi-Flex"
},
"id": "STES-540cb2b6316b11381-6474e4598dadddb51",
"type": "fare_conditions"
},
{
"attributes": {
"code": "ESC_A01PFXASBEN_1",
"description": "Paris Gare du Nord - London St Pancras Int'l - Public - Eurostar Premier\nExchangeable without a fee up to 48 hours after the original departure time. If your new ticket is more expensive, you’ll pay the difference. If your new ticket is cheaper, the difference will not be refunded. Refundable without a fee up to 48 hours after the original departure time.\n",
"title": "Public - Eurostar Premier"
},
"id": "STES-ce7c60065442a2ef1-9276c7e5acb395caf",
"type": "fare_conditions"
},
{
"attributes": {
"code": "AAFR",
"description": "The bus is easily accessible for people on wheelchairs.",
"name": "Accessible area for wheelchairs"
},
"id": "EURS-AAFR",
"type": "amenities"
},
{
"attributes": {
"booking_fee": 0,
"code": "STES",
"legal_name": "SNCF",
"markup_fee_percentage": 0.0,
"trade_name": "SNCF TEST"
},
"id": "STES",
"relationships": {
"extra_types": {
"data": []
},
"fare_classes": {
"data": [
{
"id": "STES-FARE-1",
"type": "fare_classes"
},
{
"id": "STES-FARE-2",
"type": "fare_classes"
},
{
"id": "STES-FARE-3",
"type": "fare_classes"
},
{
"id": "STES-FARE-4",
"type": "fare_classes"
},
{
"id": "STES-FARE-5",
"type": "fare_classes"
},
{
"id": "STES-FARE-6",
"type": "fare_classes"
}
]
},
"passenger_types": {
"data": [
{
"id": "PNOS",
"type": "passenger_types"
},
{
"id": "PCIL",
"type": "passenger_types"
},
{
"id": "PINT",
"type": "passenger_types"
},
{
"id": "PYPO",
"type": "passenger_types"
},
{
"id": "PSOE",
"type": "passenger_types"
}
]
}
},
"type": "marketing_carriers"
},
{
"attributes": {
"code": "EURS",
"legal_name": "SNCF",
"trade_name": "Eurostar"
},
"id": "EURS",
"type": "operating_carriers"
},
{
"attributes": {
"code": "PNOS",
"description": "",
"max_age": 59,
"min_age": 26,
"name": "Adult"
},
"id": "PNOS",
"type": "passenger_types"
},
{
"attributes": {
"code": "PCIL",
"description": "",
"max_age": 11,
"min_age": 4,
"name": "Child"
},
"id": "PCIL",
"type": "passenger_types"
},
{
"attributes": {
"code": "PINT",
"description": "",
"max_age": 3,
"min_age": 0,
"name": "Infant"
},
"id": "PINT",
"type": "passenger_types"
},
{
"attributes": {
"code": "PYPO",
"description": "",
"max_age": 25,
"min_age": 12,
"name": "Youth"
},
"id": "PYPO",
"type": "passenger_types"
},
{
"attributes": {
"code": "PSOE",
"description": "",
"max_age": 99,
"min_age": 60,
"name": "Senior"
},
"id": "PSOE",
"type": "passenger_types"
},
{
"attributes": {
"code": "FRPARPGN",
"description": "The train station is located on Rue de Dunkerque road. Passengers should find the exact platform on the information display board based on the departure time and the destination.",
"latitude": 48.88089,
"longitude": 2.354931,
"name": "Paris Gare du Nord Train Station",
"street_and_number": "18 Rue de Dunkerque",
"time_zone": "Europe/Paris",
"zip_code": "75010"
},
"id": "FRPARPGN",
"relationships": {
"area": {
"data": null
},
"city": {
"data": {
"id": "FRPAR",
"type": "cities"
}
}
},
"type": "stations"
},
{
"attributes": {
"code": "GBLONLIB",
"description": "The train station is located near the intersection of Euston road and Midland road.",
"latitude": 51.53141485394482,
"longitude": -0.12587906645073,
"name": "London St Pancras International Train Station",
"street_and_number": "Euston Rd",
"time_zone": "Europe/London",
"zip_code": "N1C 4QL"
},
"id": "GBLONLIB",
"relationships": {
"area": {
"data": null
},
"city": {
"data": {
"id": "GBLON",
"type": "cities"
}
}
},
"type": "stations"
},
{
"attributes": {
"code": "FRPAR",
"name": "Paris"
},
"id": "FRPAR",
"type": "cities"
},
{
"attributes": {
"code": "GBLON",
"name": "London"
},
"id": "GBLON",
"type": "cities"
},
{
"attributes": {
"code": "FARE-1",
"iata_category": null,
"journey_type": "single",
"name": "First Class - Flexi"
},
"id": "STES-FARE-1",
"relationships": {
"fare_features": {
"data": [
{
"id": "STES-WIFI",
"type": "fare_features"
}
]
}
},
"type": "fare_classes"
},
{
"attributes": {
"code": "FARE-2",
"iata_category": null,
"journey_type": "single",
"name": "First Class - SemiFlexi"
},
"id": "STES-FARE-2",
"relationships": {
"fare_features": {
"data": []
}
},
"type": "fare_classes"
},
{
"attributes": {
"code": "FARE-3",
"iata_category": null,
"journey_type": "single",
"name": "First Class - Cheapest"
},
"id": "STES-FARE-3",
"relationships": {
"fare_features": {
"data": []
}
},
"type": "fare_classes"
},
{
"attributes": {
"code": "FARE-4",
"iata_category": null,
"journey_type": "single",
"name": "Second Class - Cheapest"
},
"id": "STES-FARE-4",
"relationships": {
"fare_features": {
"data": []
}
},
"type": "fare_classes"
},
{
"attributes": {
"code": "FARE-5",
"iata_category": null,
"journey_type": "single",
"name": "Second Class - SemiFlexi"
},
"id": "STES-FARE-5",
"relationships": {
"fare_features": {
"data": []
}
},
"type": "fare_classes"
},
{
"attributes": {
"code": "FARE-6",
"iata_category": null,
"journey_type": "single",
"name": "Second Class - Flexi"
},
"id": "STES-FARE-6",
"relationships": {
"fare_features": {
"data": []
}
},
"type": "fare_classes"
},
{
"attributes": {
"code": "WIFI",
"description": "Wifi is available on board.",
"name": "Wifi"
},
"id": "STES-WIFI",
"type": "fare_features"
}
],
"jsonapi": {
"version": "1.0"
},
"meta": {
"currency": "EUR",
"locale": "en"
}
}For more sample responses, check the /connections/find endpoint page.
Sample Request to /connections/vacancy
HTTP
https://api.demo.distribusion.com/retailers/v4/connections/vacancy?currency=EUR&marketing_carrier=STES&departure_station=FRPARPGN&arrival_station=GBLONLIB&departure_time=2024-09-11T21:11&arrival_time=2024-09-11T22:30&passengers[][pax]=1&passengers[][type]=PNOS&fare_class=FARE-2&retailer_partner_number={{rpn}}&booking_id=WIXZu9HfZePYVd_4-lMS-QSample Response from /connections/vacancy
JSON
{
"data": {
"id": "STES-FRPARPGN-GBLONLIB-2024-09-11T21:11-2024-09-11T22:30",
"type": "vacancies",
"attributes": {
"vacant": true,
"total_price": -30600,
"original_price": -30600
},
"relationships": {
"applied_cards": {
"data": []
},
"fees": {
"data": []
},
"ancillary_options": {
"data": []
}
}
},
"jsonapi": {
"version": "1.0"
},
"meta": {
"currency": "EUR"
},
"included": []
}For more samples responses, check the /connections/vacancy endpoint page.
Sample Request to /amendments/create
JSON
{
"booking_id": "WIXZu9HfZePYVd_4-lMS-Q",
"fare_class": "FARE-2"
}Sample Response from /amendments/create
JSON
{
"data": {
"id": "A4GLXQB3",
"type": "amendments",
"attributes": {
"delta_price": 0
},
"relationships": {
"amendment_reservation": {
"data": {
"id": "ARKNXU6M2",
"type": "amendment_reservations"
}
},
"amended_booking": {
"data": {
"id": "WIXZu9HfZePYVd_4-lMS-Q",
"type": "bookings"
}
},
"booking": {
"data": null
}
}
},
"jsonapi": {
"version": "1.0"
},
"meta": {
"locale": "en",
"currency": "EUR"
},
"included": [
{
"id": "ARKNXU6M2",
"type": "amendment_reservations",
"attributes": {
"total_price": 41500,
"state": "created",
"created_at": "2024-09-10T14:23",
"confirmed_at": null,
"failed_at": null,
"processing_started_at": null,
"processing_deadline": null,
"expires_at": "2024-09-10T16:53",
"departure_time": "2024-09-11T21:11",
"arrival_time": "2024-09-11T22:30",
"terms_version": null,
"title": "mr",
"first_name": "John",
"last_name": "Smith",
"email": "andre.franchini@distribusion.com",
"phone": "+4915222088994",
"city": "Berlin",
"zip_code": "13355",
"country_code": null,
"street_and_number": "Wattstrasse 10",
"gender": null,
"country_of_birth": null,
"government_id_type": null,
"marketing_carrier_reservation_ids": [
"ARKNXU6M2"
],
"agent_id": null,
"retailer_booking_number": null,
"retailer_partner_number": "845017"
},
"relationships": {
"marketing_carrier": {
"data": {
"id": "STES",
"type": "marketing_carriers"
}
},
"fare_class": {
"data": {
"id": "FARE-2",
"type": "fare_classes"
}
},
"departure_station": {
"data": {
"id": "FRPARPGN",
"type": "stations"
}
},
"arrival_station": {
"data": {
"id": "GBLONLIB",
"type": "stations"
}
},
"errors": {
"data": []
},
"reservation_passengers": {
"data": [
{
"id": "PNOS-1-EURS-FRPARPGN-GBLONLIB-2024-09-11T21:11-2024-09-11T22:30",
"type": "reservation_passengers"
}
]
},
"applied_cards": {
"data": []
},
"ancillaries": {
"data": []
}
}
},
{
"id": "GBLONLIB",
"type": "stations",
"attributes": {
"code": "GBLONLIB"
}
},
{
"id": "FRPARPGN",
"type": "stations",
"attributes": {
"code": "FRPARPGN"
}
},
{
"id": "FARE-2",
"type": "fare_classes",
"attributes": {
"code": "FARE-2"
}
},
{
"id": "STES",
"type": "marketing_carriers",
"attributes": {
"code": "STES"
}
},
{
"id": "PNOS-1-EURS-FRPARPGN-GBLONLIB-2024-09-11T21:11-2024-09-11T22:30",
"type": "reservation_passengers",
"attributes": {
"first_name": "John",
"last_name": "Smith",
"serial_code": null,
"government_id_type": null,
"nationality": null,
"gender": null,
"country_of_birth": null,
"birthdate": "1970-07-21",
"type": "PNOS"
},
"relationships": {
"ancillaries": {
"data": []
}
}
}
]
}For more samples responses, check the /amendments/create endpoint page.
Sample Request to /amendments/confirm
JSON
{
"amendment_id": "A4GLXQB3",
"terms_accepted": true
}Sample Response from /amendments/confirm
JSON
{
"data": {
"id": "A4GLXQB3",
"type": "amendments",
"attributes": {
"delta_price": 0
},
"relationships": {
"amendment_reservation": {
"data": {
"id": "ARKNXU6M2",
"type": "amendment_reservations"
}
},
"amended_booking": {
"data": {
"id": "WIXZu9HfZePYVd_4-lMS-Q",
"type": "bookings"
}
},
"booking": {
"data": null
}
}
},
"jsonapi": {
"version": "1.0"
},
"meta": {
"locale": "en",
"currency": "EUR"
},
"included": [
{
"id": "ARKNXU6M2",
"type": "amendment_reservations",
"attributes": {
"total_price": 41500,
"state": "processing",
"created_at": "2024-09-10T14:23",
"confirmed_at": null,
"failed_at": null,
"processing_started_at": "2024-09-10T14:25",
"processing_deadline": "2024-09-10T14:35",
"expires_at": "2024-09-10T16:53",
"departure_time": "2024-09-11T21:11",
"arrival_time": "2024-09-11T22:30",
"terms_version": null,
"title": "mr",
"first_name": "John",
"last_name": "Smith",
"email": "andre.franchini@distribusion.com",
"phone": "+4915222088994",
"city": "Berlin",
"zip_code": "13355",
"country_code": null,
"street_and_number": "Wattstrasse 10",
"gender": null,
"country_of_birth": null,
"government_id_type": null,
"marketing_carrier_reservation_ids": [
"ARKNXU6M2"
],
"agent_id": null,
"retailer_booking_number": null,
"retailer_partner_number": "845017"
},
"relationships": {
"marketing_carrier": {
"data": {
"id": "STES",
"type": "marketing_carriers"
}
},
"fare_class": {
"data": {
"id": "FARE-2",
"type": "fare_classes"
}
},
"departure_station": {
"data": {
"id": "FRPARPGN",
"type": "stations"
}
},
"arrival_station": {
"data": {
"id": "GBLONLIB",
"type": "stations"
}
},
"errors": {
"data": []
},
"reservation_passengers": {
"data": [
{
"id": "PNOS-1-EURS-FRPARPGN-GBLONLIB-2024-09-11T21:11-2024-09-11T22:30",
"type": "reservation_passengers"
}
]
},
"applied_cards": {
"data": []
},
"ancillaries": {
"data": []
}
}
},
{
"id": "GBLONLIB",
"type": "stations",
"attributes": {
"code": "GBLONLIB"
}
},
{
"id": "FRPARPGN",
"type": "stations",
"attributes": {
"code": "FRPARPGN"
}
},
{
"id": "FARE-2",
"type": "fare_classes",
"attributes": {
"code": "FARE-2"
}
},
{
"id": "STES",
"type": "marketing_carriers",
"attributes": {
"code": "STES"
}
},
{
"id": "PNOS-1-EURS-FRPARPGN-GBLONLIB-2024-09-11T21:11-2024-09-11T22:30",
"type": "reservation_passengers",
"attributes": {
"first_name": "John",
"last_name": "Smith",
"serial_code": null,
"government_id_type": null,
"nationality": null,
"gender": null,
"country_of_birth": null,
"birthdate": "1970-07-21",
"type": "PNOS"
},
"relationships": {
"ancillaries": {
"data": []
}
}
}
]
}For more samples responses, check the /amendments/confirm endpoint page.
Sample Request to /amendments/{amendment_id}
Plain text
Sample Response from /amendments/{amendment_id}
JSON
{
"data": {
"id": "A4GLXQB3",
"type": "amendments",
"attributes": {
"delta_price": 0
},
"relationships": {
"amendment_reservation": {
"data": {
"id": "ARKNXU6M2",
"type": "amendment_reservations"
}
},
"amended_booking": {
"data": {
"id": "WIXZu9HfZePYVd_4-lMS-Q",
"type": "bookings"
}
},
"booking": {
"data": {
"id": "gOGhPKG1FK30-LN7CmVl2Q",
"type": "bookings"
}
}
}
},
"jsonapi": {
"version": "1.0"
},
"meta": {
"locale": "en",
"currency": "EUR"
},
"included": [
{
"id": "ARKNXU6M2",
"type": "amendment_reservations",
"attributes": {
"total_price": 41500,
"state": "confirmed",
"created_at": "2024-09-10T14:23",
"confirmed_at": "2024-09-10T14:25",
"failed_at": null,
"processing_started_at": "2024-09-10T14:25",
"processing_deadline": null,
"expires_at": "2024-09-10T16:53",
"departure_time": "2024-09-11T21:11",
"arrival_time": "2024-09-11T22:30",
"terms_version": null,
"title": "mr",
"first_name": "John",
"last_name": "Smith",
"email": "andre.franchini@distribusion.com",
"phone": "+4915222088994",
"city": "Berlin",
"zip_code": "13355",
"country_code": null,
"street_and_number": "Wattstrasse 10",
"gender": null,
"country_of_birth": null,
"government_id_type": null,
"marketing_carrier_reservation_ids": [
"ARKNXU6M2"
],
"agent_id": null,
"retailer_booking_number": null,
"retailer_partner_number": "845017"
},
"relationships": {
"marketing_carrier": {
"data": {
"id": "STES",
"type": "marketing_carriers"
}
},
"fare_class": {
"data": {
"id": "FARE-2",
"type": "fare_classes"
}
},
"departure_station": {
"data": {
"id": "FRPARPGN",
"type": "stations"
}
},
"arrival_station": {
"data": {
"id": "GBLONLIB",
"type": "stations"
}
},
"errors": {
"data": []
},
"reservation_passengers": {
"data": [
{
"id": "PNOS-1-EURS-FRPARPGN-GBLONLIB-2024-09-11T21:11-2024-09-11T22:30",
"type": "reservation_passengers"
}
]
},
"applied_cards": {
"data": []
},
"ancillaries": {
"data": []
}
}
},
{
"id": "GBLONLIB",
"type": "stations",
"attributes": {
"code": "GBLONLIB"
}
},
{
"id": "FRPARPGN",
"type": "stations",
"attributes": {
"code": "FRPARPGN"
}
},
{
"id": "FARE-2",
"type": "fare_classes",
"attributes": {
"code": "FARE-2"
}
},
{
"id": "STES",
"type": "marketing_carriers",
"attributes": {
"code": "STES"
}
},
{
"id": "PNOS-1-EURS-FRPARPGN-GBLONLIB-2024-09-11T21:11-2024-09-11T22:30",
"type": "reservation_passengers",
"attributes": {
"first_name": "John",
"last_name": "Smith",
"serial_code": null,
"government_id_type": null,
"nationality": null,
"gender": null,
"country_of_birth": null,
"birthdate": "1970-07-21",
"type": "PNOS"
},
"relationships": {
"ancillaries": {
"data": []
}
}
}
]
}For more samples responses, check the /amendments/{amendment_id} endpoint page.
Was this section helpful?
What made this section unhelpful for you?
On this page
- Amendments