Distribusion

Welcome to the Distribusion Retailer API.

The Distribusion API allows online channels of all kinds to access and distribute ground transportation in the simplest way. Distribusion’s portfolio of inventory is fully standardised and encompasses intercity bus, rail, ferry, and airport transfer services from all around the world.

To request a demo API key or receive an overview of the accessible inventory, please reach out to us at [partner@distribusion.com](https://mailto:partner@distribusion.com) and one of our Partnership Managers will be happy to get you started.

This section provides an overview of relevant guidelines and key concepts that will enable you to get started with the Distribusion Retailer API.

More details at [https://api.distribusion.com/doc/index#retailer-api.](https://api.distribusion.com/doc/index#retailer-api.)

Getting Started

Basic Integration

Enterprise Features

Other Concepts

API Endpoints

📣 What's New

Errors

Booking Engine

Intro

Integration Types

Search SDK

Examples of Booking Engines

Custom Domain

Analytics

Languages

Agent Counter

Connectivity Services

Invoicing and Payments

Dictionary

Default

Distribusion Docs

Explore the Distribusion Documentation Portal for API guides, integration tutorials, and developer tools to connect with global ground transportation solutions seamlessly.

Demo

Production

Accreditation

Advanced Pricing Insights

AI Tools

Alternative Location Identifiers

Amendments

/amendments/{amendment_id}

/amendments/confirm

/amendments/create

Ancillaries

API Authentication

Rate Limiting & Usage Policy

/price-insights/price-hints

/price-insights/price-forecast

/price-insights/calendar

/price-insights/calendar/return

Bookings

/bookings

/bookings/{booking_id}

/bookings/{booking_id}/conditions

/bookings/{booking_id}/tickets

/bookings/create

Cancellations

/cancellations/conditions

/cancellations/create

Cards

/cards

Connections

/connections/find

/connections/seats

/connections/vacancy

Marketing Carriers

/marketing_carriers

/marketing_carriers/{marketing_carrier_id}

/marketing_carriers/{marketing_carrier_id}/booking/schema

/marketing_carriers/{marketing_carrier_id}/gtfs

/marketing_carriers/{marketing_carrier_id}/stations

Post-Sales AI Bot

/post-sales-bot/chat

/post-sales-bot/chat-init

/post-sales-bot/chat/stream

Reservations

/reservations/cancel

/reservations/confirm

/reservations/create

/reservations/{reservation_id}

Stations, Areas & Cities

/areas

/cities

/connected_stations

/stations

/stations/{station_code}

Booking Confirmation

Cancel Booking

Checking Price & Vacancy

Checking Reservation Status

Confirming Reservation

Creating Reservation

Flow Overview

Preparing Metadata

Searching for Trips

Selecting Seats

MCP Server

Retailer Agent

Discount Cards

Emissions Data

GTFS

Negotiated & Corporate Fares

Real Time

Suggestion Service

Virtual Interlining

Carrier Accreditation

Accreditation Criteria

General Accreditation

Demo Environment

Postman

Preview Distribusion Content

Asynchronous Cancellations

Fees

Booking Fees

Convenience Fees

Markup Fees

Cancellation & Refund Policies

Carrier Cancellations

Terms & Conditions

Currencies

Custom Fields

Dynamic Passenger Details

Fare Classes

Fare Features & Amenities

Geo Coordinate Search

IATA and UIC Codes Search

Journey Types

Limited Day Content

Operating Carriers

Required Passenger Detail

Passenger Types

Ticket Delivery

Ticket Types

Ticket Validity

Timezones

Webhooks

Checkout Only Integration

Full Search & Book Integration

Partial Integration

### Description

Retrieve cancellation conditions for a certain booking.

To enable the cancellation of tickets through your system, you can use this endpoint to display the conditions for the cancellation of a specific booking.

**Displaying pre-book cancellation policies**

In the booking flow, it is highly recommended to display the carrier’s cancellation policy for the chosen trip and fare class to the user. Cancellation policies are defined on a fare class level in the Distribusion API and communicated through `fare_features` that are provided in the [/marketing_carriers/{marketing_carrier_id}](https://lively-space-811588.postman.co/workspace/f46e13d3-12d7-41eb-86e4-45523c4a451d/request/18003295-4b7f6a67-704f-4c88-9f76-99fd6837d089?ctx=documentation) endpoint.

Distribusion uses three standardised fare feature codes to communicate cancellation policies and provide the relevant information to be displayed to users:

- `REFU` (Fully refundable): The ticket can be fully refunded according to the carrier’s policy.
- `PREF` (Partially refundable): The ticket can be partially refunded according to the carrier’s policy.
- `NREF` (Non-refundable): The ticket cannot be refunded.
    

Each cancellation fare feature provides a carrier-specific `description` within the `attributes` array of the response, detailing the conditions whereby a customer can cancel a ticket.

For example: `The ticket can be cancelled and fully refunded before 00:00 on the departure date.`

**Displaying cancellation conditions for an existing booking**

Once a customer has booked a ticket, Distribusion enables customer facing platforms to display the cancellation conditions that apply to the user’s booking.

The [/cancellations/conditions](https://lively-space-811588.postman.co/workspace/f46e13d3-12d7-41eb-86e4-45523c4a451d/request/18003295-184b149f-2c3f-45b7-95bd-2bd997119dbb?ctx=documentation) endpoint requires only the `booking_id` to be specified and returns three parameters from which the cancellation conditions can be identified and clearly displayed:

- `allowed` - Boolean, specifies whether the booking is cancellable or not.
- `fee` - The charge that will apply to the cancellation of the booking and must be deducted from the booking price to compute the refund value. The value is provided in the carrier’s currency (fractional unit), which is also specified in the response.
- `cutoff` - The latest time at which the booking can be cancelled at this `fee`, e.g. `2021-06-15T06:05`.
    

**Note**

The [/cancellations/conditions](https://lively-space-811588.postman.co/workspace/f46e13d3-12d7-41eb-86e4-45523c4a451d/request/18003295-184b149f-2c3f-45b7-95bd-2bd997119dbb?ctx=documentation) endpoint is a live call to the carrier’s system and returns the conditions that are valid at the time of the request. These conditions can change over time if the carrier has dynamic cancellation conditions and should thus be retrieved whenever the user opens a page on which the cancellation conditions are displayed.

**Next step**

Once the cancellation conditions are presented and confirmed by the user, a cancellation request can be sent using the [/cancelations/create](https://lively-space-811588.postman.co/workspace/f46e13d3-12d7-41eb-86e4-45523c4a451d/request/18003295-6584aef2-7d0f-4adc-b823-5f132827e2aa?ctx=documentation) endpoint.

### More Info

- **Key Concepts**
    
    - [Customer cancellations](https://api.distribusion.com/doc/key-concepts#customer-cancellations)
        
- **Endpoints**
    - [GET /retailers/v4/cancellations/conditions](https://api.distribusion.com/doc/api#get-retailers-v4-cancellations-conditions-cancellations-conditions)

### Description

Create cancellation for specific booking

If the customer wishes to and the conditions permit, this endpoint enables you to execute the cancellation of a booking.

**Conducting a cancellation**

After presenting the cancellation conditions to the user using the data from the [/cancellations/conditions](https://lively-space-811588.postman.co/workspace/f46e13d3-12d7-41eb-86e4-45523c4a451d/request/18003295-184b149f-2c3f-45b7-95bd-2bd997119dbb?ctx=documentation) endpoint, the [/cancellations/create](https://lively-space-811588.postman.co/workspace/f46e13d3-12d7-41eb-86e4-45523c4a451d/request/18003295-6584aef2-7d0f-4adc-b823-5f132827e2aa?ctx=documentation) endpoint enables the execution of the cancellation and requires only the `booking_id` to be specified.

The response provides the information that can be displayed to the user to confirm the cancellation:

- `total_price` - The total price of the original booking.
- `fee` - The amount that has been charged for the cancellation.
- `total_refund` - The amount that can be refunded to the customer, calculated as `total price` - `fee`.
- `created_at` - Time stamp of execution of cancellation.
    

The booking will be cancelled in the carrier’s system and accordingly accounted for in the following clearing cycle between the retail platform and Distribusion.

### More Info

- **Key Concepts**
    
    - [Customer cancellations](https://api.distribusion.com/doc/key-concepts#customer-cancellations)
    - [Carrier cancellations](https://api.distribusion.com/doc/key-concepts#carrier-cancellations)
        
    - [Technical / Void cancellations](https://api.distribusion.com/doc/key-concepts#technical-void-cancellations)
        
- **Endpoints**
    
    - [POST /retailers/v4/cancellations/create](https://api.distribusion.com/doc/api#post-retailers-v4-cancellations-create-cancellations-create)

The Bookings section of the Distribusion API allows users to check cancellation conditions of existing bookings and cancel bookings.

The Bookings section of the Distribusion API allows users to check cancellation conditions of existing bookings and cancel bookings.

Sections

Cancellations

What made this section helpful for you?

What made this section unhelpful for you?

On this page

Sections

Cancellations

What made this section helpful for you?

What made this section unhelpful for you?

On this page

Ask an AI

Code with AI