API

Sections

Theme switcher

/amendments/create

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

For details about how this endpoint fits into the flow, check the Amendments guide.

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.

Header Parameters

api-keystring Required

Set your API key. To request a demo API key please reach out to us at partner@distribusion.com. Reference value: ZW8FXhnBl53yTkrMvoqLp4Xq7mf9nEBGsxpTWrid.

Body Parameters

booking_idstring Required

Use the ID of the booking that needs to be amended. Use the value retrieved from /reservations/{reservation_id} or /bookings/create response. Reference value: 8qbBSBst2XH39afW2WzAfQ

departure_stationstring

Set the departure station code. Use the value retrieved from the selected trip from the /connections/find response. Reference value: FRPARPGB.

arrival_stationstring

Set the arrival station code. Use the value retrieved from the selected trip from the /connections/find response. Reference value: DEBERCBS.

departure_timestring

Set the departure date and time. Use the value retrieved from the selected trip from the /connections/find response. Reference value: 2024-04-25T06:58.

arrival_timestring

Set the arrival date and time. Use the value retrieved from the selected trip from the /connections/find response. Reference value: 2024-04-25T08:30.

return_departure_timestring

Set the departure date and time for the return leg of the trip. Use the value retrieved from the selected trip from the /connections/find response. Reference value: 2024-04-26T06:22.

return_arrival_timestring

Set the arrival date and time for the return leg of the trip. Use the value retrieved from the selected trip from the /connections/find response. Reference value: 2024-04-26T10:34.

fare_classstring

Set the fare class. Use the value retrieved from the selected trip from the /connections/find response. Default set to FARE-1 if the field is not used. Reference value: FARE-1.

titlestring

Set the title of the lead passenger. The field accepts mr or mrs. Reference value: mr.

first_namestring

Set the first name of the lead passenger. Reference value: John.

last_namestring

Set the last name of the lead passenger. Reference value: Smith.

emailstring

Set the email of the lead passenger. Reference value: email@provider.com.

phonestring

Set the phone number of the lead passenger. Some carriers validate the phone number formatting. Reference value: +493533400275.

citystring

Set the city of the lead passenger. Reference value: Berlin.

zip_codestring

Set the city of the lead passenger. Reference value: 13355.

street_and_numberstring

Set the street and number of the lead passenger. Reference value: Wattstrasse 10.

passengersarray

Show child attributes

Response

200 (amend created)
Object
Successful response with amendment created

Response Attributes

dataobject

Show child attributes

jsonapiobject

Show child attributes

metaobject

Show child attributes

includedarray

Show child attributes

400 (amend not allowed)
Object
Error response: amendment not allowed

Response Attributes

errorsarray

Show child attributes

jsonapiobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot