Description

To see a full list of the carriers available through the API for your credentials, please use this endpoint. If you think there might be some carriers missing, please reach out to your account manager who can update the configuration of your credentials.

Why onboarding of meta data is important?

To see a full list of the carriers available through the API for your credentials, please use this endpoint. If you think there might be some carriers missing, please reach out to your account manager who can update the configuration of your credentials.

In order for users to search for trips, the meta data related to marketing carriers and stations will need to be retrieved and stored locally, which can be achieved by making use of the dedicated /marketing_carriers/{marketing_carrier_id} and /stations, /cities, /areas endpoints.

Once the stations and marketing carriers have been onboarded, trips can be searched by using the /connections/find endpoint.

Marketing carrier codes

Each marketing carrier possesses a unique 4-letter-code in Distribusion’s system, regardless of which mode of transport it represents.

In order to display the search results and sell tickets for a certain carrier, you will need to have previously retrieved and stored the respective metadata such as the logo, fare features, and terms & conditions.

Examples

• Heathrow Express (Airport transfer) = HEXR
• Autoservizi Salemi (Intercity bus Europe) = ASAL
• Aguia Branca (Intercity bus Brazil) = ABRA
• Schweizerische Bundesbahnen (Rail) = SINT
• Wightlink (Ferry) = WIGH
• Edinburgh Trams (Tram) = ETRM

Relevant endpoints to start onboarding marketing carriers

• To retrieve all marketing carriers available for your API credentials, please use the /marketing_carriers endpoint.
• In order to retrieve the metadata of a specific marketing carrier (e.g. its logo, terms and conditions, vehicle type, operating status, customer support contacts), please refer to the /marketing_carriers/{marketing_carrier_id} endpoint.

Note

Prior to the launch of your integration, your account manager will configure access to all agreed upon marketing carriers for your API credentials.

More Info

• Full API integration

  • Basic workflow

• Key Concepts

  • Onboarding metadata
    • Marketing carriers
  • Currencies and locales

• Endpoints

  • GET /retailers/v4/marketing_carriers

Description

To view all the meta data for a specific carrier (e.g. when onboarding a new one), please use this endpoint and save the data in your system for display upon relevant user searches.

Why onboarding of meta data is important?

In order for users to search for trips, the meta data related to marketing carriers and stations will need to be retrieved and stored locally, which can be achieved by making use of the dedicated /marketing_carriers/{marketing_carrier_id} and /stations, /cities, /areas endpoints.

Once the stations and marketing carriers have been onboarded, trips can be searched by using the /connections/find endpoint.

Marketing carrier codes

Each marketing carrier possesses a unique 4-letter-code in Distribusion’s system, regardless of which mode of transport it represents.

In order to display the search results and sell tickets for a certain carrier, you will need to have previously retrieved and stored the respective metadata such as the logo, fare features, and terms & conditions.

Examples

• Heathrow Express (Airport transfer) = HEXR
• Autoservizi Salemi (Intercity bus Europe) = ASAL
• Aguia Branca (Intercity bus Brazil) = ABRA
• Schweizerische Bundesbahnen (Rail) = SINT
• Wightlink (Ferry) = WIGH
• Edinburgh Trams (Tram) = ETRM

Relevant endpoints to start onboarding marketing carriers

• To retrieve all marketing carriers available for your API credentials, please use the /marketing_carriers endpoint.
• In order to retrieve the metadata of a specific marketing carrier (e.g. its logo, terms and conditions, vehicle type, operating status, customer support contacts), please refer to the /marketing_carriers/{marketing_carrier_id} endpoint.

Note

Prior to the launch of your integration, your account manager will configure access to all agreed upon marketing carriers for your API credentials.

More Info

• Full API integration

  • Basic workflow

• Key Concepts

  • Onboarding metadata
    • Marketing carriers
  • Currencies and locales

• Endpoints

  • GET /retailers/v4/marketing_carriers/{marketing_carrier_id}

Description

This endpoint allows you to retrieve all the stations that a specific marketing carrier uses for its trips.

Why onboarding of meta data is important?

In order for users to search for trips, the meta data related to marketing carriers and stations will need to be retrieved and stored locally, which can be achieved by making use of the dedicated /marketing_carriers/{marketing_carrier_id} and /stations, /cities, /areas endpoints.

Once the stations and marketing carriers have been onboarded, trips can be searched by using the /connections/find endpoint.

Marketing carrier codes

Each marketing carrier possesses a unique 4-letter-code in Distribusion’s system, regardless of which mode of transport it represents.

In order to display the search results and sell tickets for a certain carrier, you will need to have previously retrieved and stored the respective metadata such as the logo, fare features, and terms & conditions.

Examples

• Heathrow Express (Airport transfer) = HEXR
• Autoservizi Salemi (Intercity bus Europe) = ASAL
• Aguia Branca (Intercity bus Brazil) = ABRA
• Schweizerische Bundesbahnen (Rail) = SINT
• Wightlink (Ferry) = WIGH
• Edinburgh Trams (Tram) = ETRM

Relevant endpoints to start onboarding marketing carriers

• To retrieve all marketing carriers available for your API credentials, please use the /marketing_carriers endpoint.
• In order to retrieve the metadata of a specific marketing carrier (e.g. its logo, terms and conditions, vehicle type, operating status, customer support contacts), please refer to the /marketing_carriers/{marketing_carrier_id} endpoint.

Note

Prior to the launch of your integration, your account manager will configure access to all agreed upon marketing carriers for your API credentials.

More Info

• Full API integration

  • Basic workflow

• Key Concepts

  • Onboarding metadata
    • Marketing carriers
  • Currencies and locales

• Endpoints

  • GET /retailers/v4/marketing_carriers/{marketing_carrier_id}/stations

Description

This endpoint informs you which parameters are mandatory for a certain carrier and must be passed in bookings/create request.

Collect only required customer information

Different carriers require varying information during the booking process in order to fulfil their services and where possible, the collection of passenger information should be minimised.

In order to facilitate a dynamic checkout that gathers only necessary information from the customer, please make use of the /marketing_carriers/{marketing_carrier_id}/booking/schema endpoint, which shows the mandatory and optional parameters per carrier.

More Info

• Full API integration

  • Basic workflow

• Endpoints

  • GET /retailers/v4/marketing_carriers/{marketing_carrier_id}/booking/schema