Schemas

A reference to a customer.

Which system the customer information can be found in.

Reference to a CappedDiscountRight.

To avoid too many similar alternatives you can specify a minimum period between the start date of each alternative.

Specify a minimum alternative duration to avoid alternatives that doesn't last long enough in the future to be useful.

The netex-id of the entity.

The zones the existing ticket is valid for.

Configuration on how to configure the discount right. Requires a CustomerIdentity with source ABT.

One or more references to customer identities in different systems.

Identifier for the traveller. The travellers id will be referenced in the response where natural. Specifying an id for each traveller can make it easier to determine the seating and for whom each product is intended. If no ID is specified, the traveller will be assigned a random ID, only valid for the particular offer.

A type of traveller. An offer for userType=CHILD, will naturally be different than an offer for userType=ADULT. Subset of UserTypeEnumeration from NeTEx usage parameter eligibility support.

Specify the travellers age, to let the system calculate the corresponding userType.

A filter for what kind of luggage the traveller wants offers for. If, for example, a user wants to bring a bicycle along for the trip. "BICYCLE" can be specified in that array. Offers that can't fulfil the wish for a "BICYCLE" accommodation are still returned from our services.

Campaign codes that may grant entitlements or discounts. Usually not connected to the identity of the Traveller.

Customer-specific context used to personalise and determine entitlements for a traveller.

Which categories to use for flexibility grouping.

If not specified, all durationTypes will be considered.

If not specified, all fareClasses will be considered. Be aware that if not specified, the fareClass attribute in the recommendation object will read "fareClass":"ANY". To get the actual fareClass you would have to look up the corresponding offer.

If not specified, all accommodations will be considered. Be aware that if not specified, the facilitySet attribute in the recommendation object will read "facilitySet":"ANY". To get the actual facilitySet you would have to look up the corresponding offer.

There are two supported algorithms for organizing how we present each combination of journeys. Given three journeys in the trip pattern; SJ-1, SJ-2, SJ-3 the two algorithms will generate these combinations: SUBSEQUENT_COMBINATIONS: (SJ-1), (SJ-2), (SJ-3), (SJ-1, SJ-2), (SJ-2, SJ-3), (SJ-1, SJ-2, SJ-3) COMBINATIONS_FROM_OFFERS: Will only organize by unique journey combinations covered by offers.

There are two supported algorithms for comparing offers; TOTAL_PRICE and BEFORE_SDR. TOTAL_PRICE: This is the default algorithm used if not specified, this only looks at the total price of the offers and finds the cheapest, if two offers have the same price, the one with the least amount of offers in the combination is chosen. BEFORE_SDR: This algorithm unapplies all sales discount rights in the offers before comparing prices, when the price of two combinations is the same, the combination containing the most amount of SDRs is chosen, thereafter if the amount is the same the combination with the least amount of offers in the combination is chosen.

Only keep Offers referenced by one or more Recommendations.

Only include Recommendations with OffersToBuy.

Only applicable to multi leg journeys. If part of the journey has no Offer for the required flexibility, Recommendations will mix in a higher flexibility if it matches other parameters.

Only applicable to multi leg journeys. If part of the journey has no Offer for the required facility set, Recommendations will mix in the cheapest facility set that matches other parameters.

When enabled, only offers containing exclusively upgrade products (e.g. seat reservations) are considered for recommendations. Offers containing base fare products are excluded.

BETA: This field is in beta and may change or be removed in future versions.

How to categorise and group recommendations based on different categories. Recommendations will attempt to calculate categories from the combination of input parameters.

Determines what rules to apply when categorising and recommending offers for travellers.

The date of departure from the source origin. In most cases, this is the same date as departure from fromStopPlace. However, in the case of a ServiceJourney spanning midnight and departure from fromStopPlace is after midnight, these two dates are not equal. The correct date to use is for the ServiceJourney.

Stop place id for the origin of the leg.

Stop place id for the destination of the leg.

Service journey id for the leg.

The specific time for the chosen journey at fromStopPlaceId as specified in JourneyPlanner.

Legs constituting a suggested sequence of rides and links for this trip.

Number of compartments to group travellers in. If we are unable to fit the given travellers in the specified amount of compartments, no offer will be returned.

The travellers.

List of legs constituting a suggested sequence of rides and links for a specific trip.

Specify what types of recommendations are returned in the response. For a more in depth explanation of recommendations, see the guide for recommendations at TODO [INSERT NEW LINK].

A configuration of how to group travellers in offers.

Indicates whether multi-trip offers should be included in the response, such as monthly passes, day passes, and similar options.

Timestamp from the server.

Http error status.

Error title, typically Http reason phrase.

Error details.

Api uri.

Validation errors.

The amount.

The currency of the amount.

The VAT group.

NeTEx standard.

NeTEx standard.

Says what the distribution channel is allowed to do with this offer. Compatible with the current NeTEx implementation of DistributionRightsEnumeration at Entur.

Valid from place.

Valid to place.

Zone at the start of the journey.

Zone at the end of the journey.

Unordered list of valid fare zones through which the trip traverses.

Reference to a group of fare zones. The offer is valid through all of the zones in this group.

Service journeys where this product is valid.

Start and stop places where the product is valid.

Describes zones where a product is valid. Either a specific list of from, to and viaZones, or a reference to a GroupOfTariffZones.

Whether a seat map is available for seat selection on this service journey.

Indicates requirements for reservation. Compatible with the current NeTEx implementation of ReservationEnumeration at Entur.

A type of person. An offer for userType=CHILD, will naturally be different than an offer for userType=ADULT. Compatible with the current NeTEx implementation of UserTypeEnumeration at Entur. Related to but may include more than 'UserTypeEnum'.

the netex-id of organisation.

the name of the organisation.

Number of travellers required for this user profile in the group.

User profiles and their required number of travellers in the group.

Number of times the ticket can be used.

Validity duration of each use, formatted according to ISO-8601.

id and and name of an organisation.

Whether the ticket can be exchanged for a different departure.

Whether the ticket can be refunded.

Accommodation facilities available per service journey.

Reservation requirements per service journey.

id, version, name and user type of a user.

Validity duration of the product, formatted according to ISO-8601.

Representation of a repeatable ticket, with an optional duration for each instance and an amount of times the ticket can be used.

Validity duration. Compatible with the current NeTEx implementation of UsageValidityTypeEnumeration at Entur. Related to but may include more than 'DurationTypeEnum'.

Price with currency and optional VAT information for this element.

The id if the preassigned product.

The version of the preassigned product.

The name of the preassigned product.

The description of the preassigned product.

Summary of properties for a product. The properties field contains all necessary information about a product. Here you will find accommodations, baggageTypes, fareClass, userProfiles and more.

Describes the geographical validity of a product. Includes information on ServiceJourneys, PointToPointValidity and ZonalValidity. In cases of replacement transport, these fields describe the replacement journey.

Optional discounts applied to this product.

The ids of the travellers.

The maximum number of travellers that can be selected from the group.

The minimum number of travellers that can be selected from the group.

A type of person. An offer for userType=CHILD, will naturally be different than an offer for userType=ADULT. Compatible with the current NeTEx implementation of UserTypeEnumeration at Entur. Related to but may include more than 'UserTypeEnum'.

object ref ref.

object ref version.

A pseudo random string that is used to select what alternative to use when purchasing an offer.

Price with currency and optional VAT information for this element.

The start date of this alternative.

The end date of this alternative.

Object ref.

Object ref.

Identifier for the loyalty program.

URL to information about the loyalty program.

Whether accrual for this program is currently paused.

Identifier for the loyalty program.

URL to information about the loyalty program.

The id of an offer. This id will be referenced in recommendations where there are "offersToBuy". Also, the offerId can be used to obtain the original offer-structure from v1.

The name of the SalesPackage that this OfferSummary represents.

Id of the SalesPackage.

Version of the SalesPackage.

The description of the offer.

Price with currency and optional VAT information for this element.

Describes the geographical validity of a product. Includes information on ServiceJourneys, PointToPointValidity and ZonalValidity. In cases of replacement transport, these fields describe the replacement journey.

All mandatory products that give the buyer a right to travel is found here.

This field contains an array of selectableId's to optional products associated with an offer. The optional products are found in the field "optionalProducts" in the search response.

Mapping of which travellers this offer applies to.

Number of this offer available to buy at this point in time.

A discount might be given based on previous transactions if CappedDiscountRequest was specified. A cappingSpecification must be specified in the traveller attribute in the request to the search/ endpoints in order to receive a discount. Capping must also be enabled by the operator of the service journey.

Buying this offer may give points in these personalisation programs.

The customer may join the following programs to get points from buying this offer. It is expected that the caller does work to add the customer to the program.

Indicates whether the geographical validity covers the entire journey or not.

The service journeys this geographical validity applies to.

Start and stop places where the product is valid.

Describes zones where a product is valid. Either a specific list of from, to and viaZones, or a reference to a GroupOfTariffZones.

Id of the offer to buy.

Number of this offer to buy.

List of selectableIds of supplement products which upgrades a product.

One possible grouping of travellers for the number of offers to buy.

Describes the geographical validity covered by the recommendation.

You must select all recommendations in the list to cover the geographical validity.

Unique identifier of a recommendation within this response.

Describes the geographical validity covered by the recommendation.

Describes the degree of flexibility in a recommendation (refundable vs non-refundable, exchangeable vs non-exchangeable). Whether the recommendation is the CHEAPEST - regardless of flexibility, or whether the recommendation is for a specified product.

Describes which offer to buy and how many of this offer to buy to satisfy a recommendation.

Validity duration. Subset of UsageValidityTypeEnumeration from NeTEx usage parameter travel support.

A type of FareClass. Subset of FareClassEnumeration from NeTEx service restrictions support.

Subset of AccommodationFacilityEnumeration from NeTEx facility support.

List of RecommendationCombination covering remaining parts of the journey. The current recommendation can be combined with one of these to cover the entire journey.

Recommendations that cover the entire journey.

Recommendations that cover part of the journey. Use combineWithToCoverEntireJourney when available to build recommendations to achieve full journey coverage.

Id of the optional product.

Version of the optional product.

This is the id that is referred to from the OfferSummary's optionalProductsSelectableId's. It is also the id used when reserving the offer in later steps.

Name of the optional product.

Description of the optional product.

Price with currency and optional VAT information for this element.

Summary of properties for a product. The properties field contains all necessary information about a product. Here you will find accommodations, baggageTypes, fareClass, userProfiles and more.

Describes the geographical validity of a product. Includes information on ServiceJourneys, PointToPointValidity and ZonalValidity. In cases of replacement transport, these fields describe the replacement journey.

Optional discounts applied to this product.

How many of this optional product is available to buy at this point in time.

Describes what type of supplement product this is. Compatible with the current NeTEx implementation of SupplementProductTypeEnumeration at Entur.

Whether the product would have been exchangeable.

Whether the product would have been refundable.

id and and name of an organisation.

NeTEx ID of the unavailable product.

Status of why a product is unavailable. NOT_IN_PURCHASE_WINDOW - Product is outside of window where it can be purchased. NOT_YET_AVAILABLE - The product is not available yet, no further information is specified NO_QUOTAS_DEFINED - The product requires quotas to be purchased, but no quotas are defined yet. NO_LONGER_AVAILABLE - The product is no longer available for purchase, no further information is specified. SOLD_OUT - The product has no more seats or quotas available for sale. CLOSED - The product is closed for sale.

Human readable name for the product.

Properties of an unavailable product.

A set of recommendations matching the provided recommendation configuration.

Additional information about potentially missing information or functionality due to transient errors.

The specific time for when the ticket should be activated. For most purposes it is recommended to use the current time as travel date. That is because most period tickets are activated immediately on purchase. If you want to get a period ticket that should be activated some time in the future, specify the future date.

The id of the origin stop place or zone.

The id of the destination stop place or zone.

The travellers the offer should be valid for.

Optional sequence of via locations. Mostly useful for zone based searches.

Specify what types of recommendations are returned in the response. For a more in depth explanation of recommendations, see the guide for recommendations at TODO [INSERT NEW LINK].

Set this flag to true if you only want tickets that are valid all the way between the stop-places specified in the "from" and "to" field. When set to false, you will receive additional offers that are valid for parts of the trip with one of the stop places covered.

Optional authority ID, to further refine search. The returned Offers will only contain products allowing or requiring the provided Authority. In the case of two rail stopPlaces, Authority is set from pre-defined rules and this parameter will be ignored.

Optional transport mode, to further refine search. Most useful when there is a specific use case where there may be overlapping Offers, for instance high speed ferry or rail.

The specific time for when the ticket should be activated. For most purposes it is recommended to use the current time as travel date. That is because most period tickets are activated immediately on purchase. If you want to get a period ticket that should be activated some time in the future, specify the future date.

The travellers the offer should be valid for.

NeTEx-id of Authority. Only offers valid for this Authority will be considered.