Schemas

Reference to a resource available in a different APIs

orderVersion

integer · int32

The version of the Order this Fee is added to

Example: 2

Reference to a resource available in a different APIs

Mode

string · enum

Enum values:

AIR

BICYCLE

BUS

CABLEWAY

CAR

WATER

FUNICULAR

LIFT

Travel mode for Leg.

Order

A purchase Order for one or more Travellers

id

string · required

ID of Order.

Example: 3N7URR0X

Fee[] · required

Fees contained in the Order.

Default: []

failed

boolean · required

Indicates that the order version has failed and needs to be credited.

Default: false

status

WorkflowStatus · enum · required

Status of this Order or OrderLine. Every Order starts out with the status DRAFT, and can only be changed to CONFIRMED when it is balanced - when balance is '0.00'. All OrderLines that are have the status DRAFT at that point in time can also be changed to CONFIRMED.

Enum values:

DRAFT

CONFIRMED

Example: CONFIRMED

Default: DRAFT

balance

string · required

The balance amount for this Order.

Default: 0.00

version

integer · int32 · required

The system increments an Order’s version number whenever some change occurs that causes the Order’s status to go from CONFIRMED to DRAFT. The user has to perform an action that causes the status to go from DRAFT to CONFIRMED (such as paying for the Order) before the time given in expireAt. If the Order is not confirmed within this time, the system will scrap all changes (including the incremented version) and return the Order to its last confirmed version.

Example: 2

Default: 1

currency

string · required

The currency for this Order.

Default: NOK

createdAt

string · date-time · required

Timestamp for when Order was created.

Example: 2020-05-13T07:19:30.389Z

OrderLine[] · required

OrderLines in the given Order.

Default: []

Traveller[] · required

Unique Travellers in this Order.

Default: []

PaymentRef[] · required

Payment references used on this Order.

Default: []

totalAmount

string · required

The total amount due for this Order.

Default: 0.00

PurchasedReservation[] · required

Seating Reservations connected to this Order.

Default: []

organisationId

integer · int64 · required

ID of the organisation which created/sold this Order.

Example: 1

totalTaxAmount

string · required

The total tax amount for this Order.

Default: 0.00

pos

string

Point-of-sale reference of request used when Order was created

Example: POS-123

lastConfirmedAt

string · date-time

Timestamp for when Order was last confirmed.

Example: 2020-05-13T07:19:30.389Z

distributionChannelId

string

Distribution channel ID of request used when Order was created

Example: ENT:DistributionChannel:Sor

expireAt

string · date-time

Any changes not confirmed before this point in time will be discarded. Default is 20 minutes from the last operation. Cannot be in the past, or further into the future than six months.

Example: 2020-05-13T07:19:30.389Z

ContactInfo

Contact information related to different aspects in the lifecycle of an Order.

externalReference

string

External reference for Orders

Example: 3N7URR0X

SpecialOrderCause

Holder for fields used to explain why an Order has been issued. Used for zero tickets.

AddedBy

Metadata about who or what added the OrderLine.

pos

string

Point-of-sale reference of request used when OrderLine was added.

Example: POS-123

distributionChannelId

string

Distribution channel ID of request used when OrderLine was added.

Example: ENT:DistributionChannel:Sor

RefType

Reference to a resource available in a different APIs

id

string · required

ID of the resources

Example: ENT:Resource:12345

version

string

A specific version of the resource if applicable

Example: 1

SubMode

string · enum

Enum values:

UNKNOWN

UNDEFINED

INTERNATIONAL_FLIGHT

DOMESTIC_FLIGHT

INTERCONTINENTAL_FLIGHT

DOMESTIC_SCHEDULED_FLIGHT

SHUTTLE_FLIGHT

INTERCONTINENTAL_CHARTER_FLIGHT

The transport sub mode (e.g., localBus or expressBus) used when traversing this leg. Null if leg is not a ride

Example: LOCAL

Default: UNDEFINED

ApiError

path

string · required

error

string · required

title

string · required

Short, human-readable summary of the problem

status

integer · int32 · required

message

string · required

exception

string · required

timestamp

string · date-time · required

Distance

A distance value with a unit.

unit

DistanceUnit · enum · required

Unit of distance measurement.

Enum values:

METER

KILOMETER

value

number · decimal · required

The distance value.

Example: 12.5

UsageEnd

string · enum

Enum values:

STANDARD_DURATION

END_OF_CALENDAR_PERIOD

END_OF_RIDE

END_OF_TRIP

END_OF_FARE_DAY

END_OF_FARE_PERIOD

PRODUCT_EXPIRY

PROFILE_EXPIRY

OrderLine

id

string · uuid · required

ID of OrderLine

Example: dd3e1d71-1c96-4b88-a683-538a8724ee0d

status

WorkflowStatus · enum · required

Status of this Order or OrderLine. Every Order starts out with the status DRAFT, and can only be changed to CONFIRMED when it is balanced - when balance is '0.00'. All OrderLines that are have the status DRAFT at that point in time can also be changed to CONFIRMED.

Enum values:

DRAFT

CONFIRMED

Example: CONFIRMED

Default: DRAFT

version

integer · int32 · required

Version of this OrderLine. This is iterated when the OrderLine is updated, but not when it is replaced.

Example: 1

Default: 1

createdAt

string · date-time · required

Timestamp for when the OrderLine was created.

PriceWithTax · required

Price with included tax amounts and an optional rate.

PurchasedTraveller[] · required

The Travellers that are to travel on this OrderLine.

Default: []

TextInLanguage[] · required

Description.

Default: []

PurchasedFareProduct[] · required

The underlying FareProducts which make up this SalesPackage.

Default: []

PriceWithTax · required

Price with included tax amounts and an optional rate.

AddedBy

Metadata about who or what added the OrderLine.

Example: {"pos":"123","distributionChannelId":"ABC:DistributionChannel:MyCompany"}

refunded

boolean

If true = refunded, false = cancelled, null = active

cancellation

CancellationReason · enum

Cancellation reason for an OrderLine. OrderLines with REPLACED have been replaced with a newer version.

Enum values:

CANCELLED

REPLACED

lastConfirmedAt

string · date-time

Timestamp for when the OrderLine was last confirmed.

Possible additional parameters for the configurations

privateCode

string

Private code.

Reference to a resource available in a different APIs

externalReference

string

External reference to another system supplied by the client.

Example: 3N7URR0X

object

A map of client provided data. No validation is performed, and no guarantee can be made about its contents.

DistributionDetails

Wrapper for references connected to distribution of travel rights and/or tickets

Classification of the products chosen.

TravelSpecification

externalConfirmation

string

External confirmation status for this OrderLine. Allowed values: PENDING, SUCCESS, FAILED.

effectiveCancellationDate

string · date-time

If set, the effective date for cancellation. Overrides timestamp.

Example: 2020-05-13T07:19:30.389Z

Traveller

A Traveller object which might hold a reference to a Customer

id

string · uuid · required

Customer reference.

FeeRequest

Fee related to one or more OrderLines

type

string · required

Type of Fee. Valid types: MANUAL, REFUNDING, ONBOARD, CHANGE, INVOICE, CHANGE_NON_REFUNDABLE, PENALTY, BOOKING, REDUCTION

Example: REFUND

PriceWithTax · required

Price with included tax amounts and an optional rate.

reason

string · required

Explanatory text describing the reason for the Fee, if applicable

Example: VYB:Refunding:HalfRefunded

Default:

orderLineIds

string[] · required

References to the OrderLines this Fee refers to, if applicable. If empty, the fee refers to all order lines

Default: []

Reference to a resource available in a different APIs

orderVersion

integer · int32

The version of the Order this Fee is added to

Example: 2

Reference to a resource available in a different APIs

Limitation

GroupTicket

Reference to a resource available in a different APIs

Reference to a resource available in a different APIs

Reference to a resource available in a different APIs

DynamicUsageValidityPeriod

A dynamic UsageValidtyPeriod that is generated on the fly. Thus lacking id and version as it can not be referenced

PaymentRef

References to Payments

amount

string · required

The Payment amount. Maximum (totalDigits: 18, fractionDigits: 5) according to ISO 20022.

Example: 129.5

currency

string · required

Example: NOK

Default: NOK

completedAt

string · date-time · required

Timestamp for when Payment was completed

Example: 2018-09-02T07:36:00Z

orderVersion

integer · int32 · required

Order version number this Payment confirmed.

Example: 2

creditId

integer · int64

Reference to the Credit.

Example: 2321

paymentId

integer · int64

Reference to the Payment.

Example: 12352

settlementId

integer · int64

Supplied to the client by an external system for handling settlements. For Internal Entur Clients this is Entur’s Electronic Journal.

Example: 18332

ContactInfo

Contact information related to different aspects in the lifecycle of an Order.

Customer reference.

Customer reference.

CustomerRef

Customer reference.

id

string · required

ID for Customer

Example: 12345

Entitlement

Information about the product and contract used when generating offer

RefType · required

Reference to a resource available in a different APIs

contractId

string

ID of contract used by Traveller for OrderLine

Example: 598db4f3-ffcc-437c-82a9-d7239ec1ca3f

Reference to a resource available in a different APIs

GroupTicket

CompanionProfile[] · required

derivedFromObjectRef

string

Identity of object from which this object of ENTITY was derived. Normally the same.

Example: ENT:groupTicket:12345

derivedFromVersionRef

string

Version of this object from which this version of ENTITY was derived.

Example: 2

PageOfOrder

Page displays a subset of a list of entities

Order[] · required

Items on a specific page

Default: []

totalItems

integer · int64 · required

Total number of items

Example: 72

totalPages

integer · int64 · required

Total number of pages available to browse

Example: 9

DistanceUnit

string · enum

Enum values:

METER

KILOMETER

Unit of distance measurement.

OrderRequest

A purchase Order for one or more Travellers

expireAt

string · date-time

Any changes not confirmed before this point in time will be discarded. Default is 20 minutes from the last operation. Cannot be in the past, or further into the future than six months.

Example: 2020-05-13T07:19:30.389Z

ContactInfo

Contact information related to different aspects in the lifecycle of an Order.

externalReference

string

External reference for Orders

Example: 3N7URR0X

SpecialOrderCause

Holder for fields used to explain why an Order has been issued. Used for zero tickets.

PriceWithTax

Price with included tax amounts and an optional rate.

amount

string · required

Amount including tax amount.

Example: 399.00

currency

string · required

Currency

Example: NOK

Default: NOK

taxAmount

string · required

Tax amount

Example: 36.27

taxCode

string

Tax code for this tax rate

Example: 33

taxRate

string

Tax rate. Must be in valid BigDecimal format

Example: 12.00

PurchasedLeg

Part of a trip between two places.

id

string · required

mode

Mode · enum · required

Travel mode for Leg.

Enum values:

AIR

BICYCLE

BUS

CABLEWAY

CAR

WATER

FUNICULAR

LIFT

endTime

string · date-time · required

The date and time this Leg ends.

Example: 2023-10-12T15:00:00Z

subMode

SubMode · enum · required

The transport sub mode (e.g., localBus or expressBus) used when traversing this leg. Null if leg is not a ride

Enum values:

UNKNOWN

UNDEFINED

INTERNATIONAL_FLIGHT

DOMESTIC_FLIGHT

INTERCONTINENTAL_FLIGHT

DOMESTIC_SCHEDULED_FLIGHT

SHUTTLE_FLIGHT

INTERCONTINENTAL_CHARTER_FLIGHT

Example: LOCAL

Default: UNDEFINED

startTime

string · date-time · required

The date and time this Leg begins.

Example: 2023-10-12T14:30:00Z

RefType · required

Reference to a resource available in a different APIs

RefType · required

Reference to a resource available in a different APIs

RefType · required

Reference to a resource available in a different APIs

RefType · required

Reference to a resource available in a different APIs

RefType · required

Reference to a resource available in a different APIs

lineId

string

Line ID

Example: ENT:Line:1

InterchangeTo

Connected ServiceJourneys without changing material

organisationId

integer · int64

The organisation that owns the service journey on this leg, Alternative identifier to authorityRef or operatorRef.

Example: 1234

RailReplacementInfo

Present only when this leg is a rail replacement bus service. Contains the original train station stop place references that were used for pricing.

Reference to a resource available in a different APIs

serviceJourneyPrivateCode

string

Private code of the ServiceJourney

Example: ENT-1234

Reference to a resource available in a different APIs

SetSelection

string · enum

Enum values:

ONE_OF_ANY_ONE_SET

ONE_OF_EACH_SET

SOME_OF_ANY_SET

ALL_OF_ONE_SET

ALL_OF_ALL_SETS

Set selection type for a group containing multiple elements

UsageTrigger

string · enum

Enum values:

ENROLMENT

RESERVATION

PURCHASE

FULFILMENT

ACTIVATION

SPECIFIED_START_DATE

START_OUTBOUND_RIDE

END_OUTBOUND_RIDE

InterchangeTo

Connected ServiceJourneys without changing material

staySeated

boolean · required

Passengers should remain seated when travelling from and to ServiceJourneys referenced in this object

RefType · required

Reference to a resource available in a different APIs

RefType · required

Reference to a resource available in a different APIs

ZonalValidity

Zones where the product is valid

fareZones

string[] · required

Valid in fare zones

Default: []

groupOfTariffZones

string[] · required

Reference to a group of tariff zones. All zones in the group are valid.

Default: []

PurchasedGroup

A representation of group product

PriceWithTax · required

Price with included tax amounts and an optional rate.

PurchasedUserProfileSummary[] · required

A collection of all the different user profiles with price and tax in the group.

Default: []

RefType · required

Reference to a resource available in a different APIs

RefType[] · required

The UserProfile IDs that are given rights to travel with this GroupTicket.

Default: []

PriceWithTax · required

Price with included tax amounts and an optional rate.

TextInLanguage

lang

string · required

Language code according to ISO 639-3

Example: nob

value

string · required

A text to describe the contents of this OrderLine

Example: Tekstlige detaljer om ordrelinjen

WorkflowStatus

string · enum

Enum values:

DRAFT

CONFIRMED

Status of this Order or OrderLine. Every Order starts out with the status DRAFT, and can only be changed to CONFIRMED when it is balanced - when balance is '0.00'. All OrderLines that are have the status DRAFT at that point in time can also be changed to CONFIRMED.

Example: CONFIRMED

Default: DRAFT

ActivationMeans

string · enum

Enum values:

AUTOMATIC_BY_TIME

CHECK_IN

NONE_REQUIRED

OTHER

USE_OF_MOBILE_DEVICE

USE_OF_VALIDATOR

LogicalOperator

string · enum

Enum values:

AND

OR

XOR

NOT

NAND

XNOR

NOR

Logical operator

OrganisationRef

The Organisation that owns the FareProduct

id

string · required

ID for an Organisation

privateCode

integer · int64 · required

Private code used to reference an Organisation

CompanionProfile

maximumNumberOfPersons

integer · required

minimumNumberOfPersons

integer · required

Reference to a resource available in a different APIs

FailOrderRequest

orderLineIds

string[] · required

IDs of order lines that failed external confirmation. Must be order lines with externalConfirmation=PENDING.

OrderLineRequest

PriceWithTax · required

Price with included tax amounts and an optional rate.

PurchasedTraveller[] · required

The Travellers that are to travel on this OrderLine.

Default: []

TextInLanguage[] · required

Description.

Default: []

PurchasedFareProduct[] · required

The underlying FareProducts which make up this SalesPackage.

Default: []

PriceWithTax · required

Price with included tax amounts and an optional rate.

id

string · uuid

Id for an OrderLine, required when updating orderLines

Example: dd3e1d71-1c96-4b88-a683-538a8724ee0d

Possible additional parameters for the configurations

privateCode

string

Private code.

Reference to a resource available in a different APIs

externalReference

string

External reference to another system supplied by the client.

Example: 3N7URR0X

object

A map of client provided data. No validation is performed, and no guarantee can be made about its contents.

DistributionDetails

Wrapper for references connected to distribution of travel rights and/or tickets

Classification of the products chosen.

TravelSpecification

externalConfirmation

string

External confirmation status for this OrderLine. Allowed values: PENDING, SUCCESS, FAILED.

effectiveCancellationDate

string · date-time

If set, the effective date for cancellation. Overrides timestamp.

Example: 2020-05-13T07:19:30.389Z

TravellerRequest

A Traveller object which might hold a reference to a Customer

Customer reference.

SpecialOrderCause

Holder for fields used to explain why an Order has been issued. Used for zero tickets.

causeCode

string · required

The cause code for issuing the Order.

Example: DELAY

organisationId

string

The organisation responsible for the cause. Eg. the Operator responsible for the delay causing a zero ticket to be issued. Should not be confused with the organisationId of the Order, as this has no correlation.

Example: 1

ValidityParameter

ValidityParameter object.

Reference to a resource available in a different APIs

Reference to a resource available in a different APIs

Reference to a resource available in a different APIs

Reference to a resource available in a different APIs

Reference to a resource available in a different APIs

Reference to a resource available in a different APIs

CancellationReason

string · enum

Enum values:

CANCELLED

REPLACED

Cancellation reason for an OrderLine. OrderLines with REPLACED have been replaced with a newer version.

OrderCreateRequest

Optional configuration to use when creating an Order

currency

string

The currency for this Order.

Default: NOK

expireAt

string · date-time

Any changes not confirmed before this point in time will be discarded. Default is 20 minutes from the last operation. Cannot be in the past, or further into the future than six months.

Example: 2020-05-13T07:19:30.389Z

ContactInfo

Contact information related to different aspects in the lifecycle of an Order.

externalReference

string

External reference for Orders

Example: 3N7URR0X

organisationOverride

string

If present, the Order will be created on behalf of the given organisation ID, rather than the organisation associated with the token. Requires special agreements before use is allowed.

Example: 2

PurchasedFareClass

string · enum

Enum values:

FIRST_CLASS

SECOND_CLASS

THIRD_CLASS

ECONOMY_CLASS

BUSINESS_CLASS

TURISTA

PREFERENTE

STANDARD_CLASS

Type of FareClass chosen by customer

PurchasedTraveller

Traveller for OrderLine

travellerId

string · uuid · required

ID for Traveller

Entitlement[] · required

Entitlement information for the customer and the OrderLine

Default: []

givenConsentId

string

DistributionDetails

Wrapper for references connected to distribution of travel rights and/or tickets

Reference to a resource available in a different APIs

Reference to a resource available in a different APIs

distributionHolderCustomerId

string

Reference to a customer who will use the travel right

Example: 12345

TravelDocumentDetails

Reference to a resource available in a different APIs

PurchasedParameters

Possible additional parameters for the configurations

PurchasedUsageParameter[] · required

Reference to replacing parameters with price information.

Default: []

PurchasedUsageParameter[] · required

Reference to reserving parameters with price information.

Default: []

PurchasedUsageParameter[] · required

Reference to round trip parameters with price information.

Default: []

PurchasedUsageParameter[] · required

Reference to exchanging parameters with price information.

Default: []

PurchasedUsageParameter[] · required

Reference to entitlement products used when calculating price

Default: []

PurchasedUsageParameter[] · required

Reference to luggage allowance parameters with price information.

Default: []

PurchasedGroup

A representation of group product

PurchasedUserProfile

A representation of a user profile

PurchasedUsageParameter

A simple representation of a UsageParameter

PurchasedProperties

Classification of the products chosen.

purchasedFareClasses

PurchasedFareClass[] · required

Type of FareClass chosen by customer

Enum values:

FIRST_CLASS

SECOND_CLASS

THIRD_CLASS

ECONOMY_CLASS

BUSINESS_CLASS

TURISTA

PREFERENTE

STANDARD_CLASS

Default: []

purchasedAccommodations

PurchasedAccommodation[] · required

Type of accommodation chosen by customer

Enum values:

SLEEPER

SEATING

DOUBLE_SLEEPER

SINGLE_SLEEPER

SPECIAL_SLEEPER

COUCHETTE

SINGLE_COUCHETTE

DOUBLE_COUCHETTE

Default: []

RailReplacementInfo

Present only when this leg is a rail replacement bus service. Contains the original train station stop place references that were used for pricing.

originalToStopPlaceRef

string · required

The stop place ref of the original train station where the passenger would have alighted.

originalFromStopPlaceRef

string · required

The stop place ref of the original train station where the passenger would have boarded.

TravelSpecification

PurchasedFareProductValidity[] · required

The FareProductValidities for a product.

Default: []

PurchasedLeg[]

The Legs of a planned travel route. Only Legs which are rides are expected to be added.

aimedEndTime

string · date-time

Timestamp used when determining the end of the ticket's validity. Taken from the offer used by the end user when ordering the ticket. No fallback, null if not available on offer.

Example: 2023-10-12T15:30:00Z

aimedStartTime

string · date-time

Timestamp used when determining the beginning of the ticket's validity. Taken from the offer used by the end user when ordering the ticket. Note that the fallback timestamp is the timestamp at which the orderLine was added to the Order.

Example: 2023-10-12T14:30:00Z

Distance

A distance value with a unit.

RefType[]

The StopPlaces the product is valid between. The first element in this array will be the StopPlace the Traveller is travelling from, and the second element will be the StopPlace the Traveller is travelling to. There will never be more than two elements in this array.

PointToPointValidity

Start and StopPlaces where the entity is valid

toPlace

string · required

Valid to StopPlace

fromPlace

string · required

Valid from StopPlace

PurchasedFareProduct

Configuration for a purchased Fare Product

PriceWithTax · required

Price with included tax amounts and an optional rate.

legIds

string[] · required

The IDs of the Legs that are connected to this FareProduct.

Default: []

RefType · required

Reference to a resource available in a different APIs

PriceWithTax · required

Price with included tax amounts and an optional rate.

PurchasedValidableElement[] · required

The ValidableElement configurations which makes up this FareProduct.

amount

integer · int32

Amount of priced unit

elementId

string

Unique ID for this specific PurchasedFareProduct. Note that this ID is only for distinguishing parts of an orderLine. It has no use outside of the orderLine, and can't be found in any other service.

Example: e3d13c4f-3f0e-4b2e-9f4a-5b8c7e2d6a1b

Possible additional parameters for the configurations

validityId

string

Unique identifier for a purchased FareProduct with validity

PurchasedFareProduct

Configuration for a purchased Fare Product

OrganisationRef

The Organisation that owns the FareProduct

PurchasedSaleDiscountRight

Configuration for a Discount Right

fareAgreementNumber

integer · int32

Fare agreement identifier

Classification of the products chosen.

purchasedProductType

PurchasedProductType · enum

Type of priced unit

Enum values:

TRIP_CARNET

PASS_CARNET

UNIT_COUPONS

STORED_VALUE

OTHER

originatingFromProductId

string

The ID of the entitlement product that allowed the sale discount right to be used

PurchasedProductType

string · enum

Enum values:

TRIP_CARNET

PASS_CARNET

UNIT_COUPONS

STORED_VALUE

OTHER

Type of priced unit

PurchasedReservation

reservationId

string · uuid · required

ID and version of the Reservation.

Example: de3299ae-b54c-4747-b915-d8536e1a9741

RefType · required

Reference to a resource available in a different APIs

PurchasedUserProfile

A representation of a user profile

PriceWithTax · required

Price with included tax amounts and an optional rate.

RefType · required

Reference to a resource available in a different APIs

PriceWithTax · required

Price with included tax amounts and an optional rate.

typeOfConcession

string

The type of concession for this UserProfile

Example: SENIOR

TravelDocumentDetails

RefType · required

Reference to a resource available in a different APIs

distributionAction

TravelDocumentDistributionAction · enum · required

Enum values:

ATTACH_FARE_CONTRACT_AND_ACTIVATE

PurchasedAccommodation

string · enum

Enum values:

SLEEPER

SEATING

DOUBLE_SLEEPER

SINGLE_SLEEPER

SPECIAL_SLEEPER

COUCHETTE

SINGLE_COUCHETTE

DOUBLE_COUCHETTE

Type of accommodation chosen by customer

PurchasedUsageParameter

A simple representation of a UsageParameter

PriceWithTax · required

Price with included tax amounts and an optional rate.

PriceWithTax · required

Price with included tax amounts and an optional rate.

RefType · required

Reference to a resource available in a different APIs

ConfirmOrderLinesRequest

orderLineIds

string[] · required

IDs of order lines to confirm. Must be order lines with externalConfirmation=PENDING.

PurchasedValidableElement

Configuration for a ValidableElement

PriceWithTax · required

Price with included tax amounts and an optional rate.

legIds

string[] · required

The Leg IDs that are connected to this ValidableElement.

Default: []

PriceWithTax · required

Price with included tax amounts and an optional rate.

RefType · required

Reference to a resource available in a different APIs

PurchasedFareStructureElement[] · required

The underlying FareStructureElement configurations which makes up this ValidableElement

occurs

integer · int32

The number of instances of this particular type of ValidableElement that is collected in this FareProduct

elementId

string

Unique ID for this specific PurchasedValidableElement. Note that this ID is only for distinguishing parts of an orderLine. It has no use outside of the orderLine, and can't be found in any other service.

Example: a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6

Possible additional parameters for the configurations

Classification of the products chosen.

PurchasedDiscountUsageParameters

DynamicUsageValidityPeriod

A dynamic UsageValidtyPeriod that is generated on the fly. Thus lacking id and version as it can not be referenced

usageEnd

UsageEnd · enum

Enum values:

STANDARD_DURATION

END_OF_CALENDAR_PERIOD

END_OF_RIDE

END_OF_TRIP

END_OF_FARE_DAY

END_OF_FARE_PERIOD

PRODUCT_EXPIRY

PROFILE_EXPIRY

endDateTime

string · date-time

EndDate

Example: 2020-05-13T07:19:30.389Z

usageTrigger

UsageTrigger · enum

Enum values:

ENROLMENT

RESERVATION

PURCHASE

FULFILMENT

ACTIVATION

SPECIFIED_START_DATE

START_OUTBOUND_RIDE

END_OUTBOUND_RIDE

startDateTime

string · date-time

StartDateTime

Example: 2020-05-13T07:19:30.389Z

activationMeans

ActivationMeans[]

Activation Means. Describes how a product can be activated.

Enum values:

AUTOMATIC_BY_TIME

CHECK_IN

NONE_REQUIRED

OTHER

USE_OF_MOBILE_DEVICE

USE_OF_VALIDATOR

Default: []

standardDuration

string · duration

Standard duration. Represented as a string formatted according to ISO-8601

Example: PT1H

PurchasedSaleDiscountRight

Configuration for a Discount Right

PriceWithTax · required

Price with included tax amounts and an optional rate.

RefType · required

Reference to a resource available in a different APIs

PriceWithTax · required

Price with included tax amounts and an optional rate.

Possible additional parameters for the configurations

originatingFromProductId

string

The ID of the EntitlementProduct that allowed the SaleDiscountRight to be used.

Example: ENT:EntitlementProduct:1

PurchasedUserProfileSummary

A representation of a user profile to summarize parts of a purchased group. Multiply `count` with `priceContribution` to get sum of all user profiles of same type.

count

integer · required

The number of travellers with given user profile.

Example: 3

PriceWithTax · required

Price with included tax amounts and an optional rate.

RefType · required

Reference to a resource available in a different APIs

PriceWithTax · required

Price with included tax amounts and an optional rate.

SpecificParameterAssignment

SpecificParameterAssignment[]

Included SpecificParameterAssignments

Limitation[]

Limitations

ValidityParameter[]

Validity parameters

includesGroupingType

LogicalOperator · enum

Logical operator

Enum values:

AND

OR

XOR

NOT

NAND

XNOR

NOR

limitationGroupingType

LogicalOperator · enum

Logical operator

Enum values:

AND

OR

XOR

NOT

NAND

XNOR

NOR

DynamicDistanceMatrixElement

Reference to a resource available in a different APIs

validityParameterGroupingType

LogicalOperator · enum

Logical operator

Enum values:

AND

OR

XOR

NOT

NAND

XNOR

NOR

Reference to a resource available in a different APIs

validityParameterSetSelectionType

SetSelection · enum

Set selection type for a group containing multiple elements

Enum values:

ONE_OF_ANY_ONE_SET

ONE_OF_EACH_SET

SOME_OF_ANY_SET

ALL_OF_ONE_SET

ALL_OF_ALL_SETS

DynamicDistanceMatrixElement

Reference to a resource available in a different APIs

Reference to a resource available in a different APIs

Reference to a resource available in a different APIs

PurchasedGeographicalInterval

Reference to a resource available in a different APIs

PurchasedFareProductValidity

The PointToPontValidity or ZonalValidity this FareProduct contains.

validityId

string · required

Unique identifier for a purchased FareProduct with validity

ZonalValidity

Zones where the product is valid

PointToPointValidity

Start and StopPlaces where the entity is valid

PurchasedFareStructureElement

Configuration for a FareStructureElement

PriceWithTax · required

Price with included tax amounts and an optional rate.

legIds

string[] · required

The Leg IDs that are connected to this FareStructureElement

Default: []

PriceWithTax · required

Price with included tax amounts and an optional rate.

RefType · required

Reference to a resource available in a different APIs

The Geographical Interval with distance and zone data.

elementId

string

Unique ID for this specific PurchasedFareStructureElement. Note that this ID is only for distinguishing parts of an orderLine. It has no use outside of the orderLine, and can't be found in any other service.

Possible additional parameters for the configurations

Classification of the products chosen.