Entur Developer
Orders
Orders

Schemas

Download schema

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

CancellationReason

string · enum
Enum values:
CANCELLED
REPLACED

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

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

DynamicDistanceMatrixElement

​RefType

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

LogicalOperator

string · enum
Enum values:
AND
OR
XOR
NOT
NAND
XNOR
NOR

Logical operator

ValidityParameter

ValidityParameter object.
​RefType

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

SpecificParameterAssignment

​RefType

Reference to a resource available in a different APIs

​DynamicDistanceMatrixElement
includesGroupingType
​LogicalOperator · enum

Logical operator

Enum values:
AND
OR
XOR
NOT
NAND
XNOR
NOR
​ValidityParameter[]

Validity parameters

​RefType

Reference to a resource available in a different APIs

validityParameterGroupingType
​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

Included SpecificParameterAssignments

​Limitation[]

Limitations

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

UsageTrigger

string · enum
Enum values:
ENROLMENT
RESERVATION
PURCHASE
FULFILMENT
ACTIVATION
SPECIFIED_START_DATE
START_OUTBOUND_RIDE
END_OUTBOUND_RIDE

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

ActivationMeans

string · enum
Enum values:
AUTOMATIC_BY_TIME
CHECK_IN
NONE_REQUIRED
OTHER
USE_OF_MOBILE_DEVICE
USE_OF_VALIDATOR

DynamicUsageValidityPeriod

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

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

Example: PT1H
startDateTime
​string · date-time

StartDateTime

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
endDateTime
​string · date-time

EndDate

Example: 2020-05-13T07:19:30.389Z
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
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: []

CompanionProfile

minimumNumberOfPersons
​integer · required
maximumNumberOfPersons
​integer · required
​RefType

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

Limitation

​DynamicUsageValidityPeriod

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

​RefType

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

​GroupTicket

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

PurchasedParameterSpecification

specificationOf
​string

Specification of parameter id

​SpecificParameterAssignment

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

PriceWithTax

Price with included tax amounts and an optional rate.
amount
​string · required

Amount including tax amount.

Example: 399.00
taxAmount
​string · required

Tax amount

Example: 36.27
currency
​string · required

Currency

Example: NOK
Default: NOK
taxRate
​string

Tax rate. Must be in valid BigDecimal format

Example: 12.00
taxCode
​string

Tax code for this tax rate

Example: 33

LocalPriceWithTax

The original price, with tax, in the local currency of the tax country.
amount
​string · required

Amount including tax amount.

Example: 372.90
currency
​string · required

Currency

Example: SEK
exchangeRate
​string · required

Exchange rate used at creation time to convert the local currency into the order's currency. It is the number of units of the order currency paid for 1 (one) unit of the local currency. Must be in valid BigDecimal format. E.g., if the order currency is NOK and the local currency is EUR, and 1 EUR = 10 NOK, then the exchange rate is 10.0000. If the order currency is NOK and the local currency is SEK, and 100 SEK = 96.21 NOK, then the exchange rate is 0.9621.

Example: 0.9621
taxAmount
​string · required

Tax amount

Example: 22.37
taxCountry
​string · pattern: ^[A-Z]{2}$ · required

ISO 3166-1 alpha-2 country code

Example: SE
taxRate
​string · required

Tax rate. Must be in valid BigDecimal format

Example: 6.00

PurchasedUserProfile

A representation of a user profile
​RefType · required

Reference to a resource available in a different APIs

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​PriceWithTax · required

Price with included tax amounts and an optional rate.

typeOfConcession
​string

The type of concession for this UserProfile

Example: SENIOR

PurchasedUsageParameter

A simple representation of a UsageParameter
​RefType · required

Reference to a resource available in a different APIs

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​PriceWithTax · required

Price with included tax amounts and an optional rate.

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.
​RefType · required

Reference to a resource available in a different APIs

count
​integer · required

The number of travellers with given user profile.

Example: 3
​PriceWithTax · required

Price with included tax amounts and an optional rate.

​PriceWithTax · required

Price with included tax amounts and an optional rate.

PurchasedGroup

A representation of group product
​RefType · required

Reference to a resource available in a different APIs

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​RefType[] · required

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

Default: []
​PurchasedUserProfileSummary[] · required

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

Default: []

PurchasedParameters

Possible additional parameters for the configurations
​PurchasedUsageParameter[] · required

Reference to luggage allowance parameters with price information.

Default: []
​PurchasedUsageParameter[] · required

Reference to exchanging parameters with price information.

Default: []
​PurchasedUsageParameter[] · required

Reference to reserving parameters with price information.

Default: []
​PurchasedUsageParameter[] · required

Reference to replacing parameters with price information.

Default: []
​PurchasedUsageParameter[] · required

Reference to round trip parameters with price information.

Default: []
​PurchasedUsageParameter[] · required

Reference to entitlement products used when calculating price

Default: []
​PurchasedUserProfile

A representation of a user profile

​PurchasedUsageParameter

A simple representation of a UsageParameter

A representation of group product

PurchasedGeographicalInterval

The Geographical Interval with distance and zone data.
​RefType · required

Reference to a resource available in a different APIs

fareZones
​string[] · required

A list of fare zones that exist in this interval. Empty if not relevant.

Default: []
distance
​number · double

The distance in the geographical interval.

Example: 12.5
zoneCount
​integer · int32

Number of zones counted for the journey.

Example: 3

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

PurchasedAccommodation

string · enum
Enum values:
SLEEPER
SEATING
DOUBLE_SLEEPER
SINGLE_SLEEPER
SPECIAL_SLEEPER
COUCHETTE
SINGLE_COUCHETTE
DOUBLE_COUCHETTE

Type of accommodation chosen by customer

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: []

PurchasedFareStructureElement

Configuration for a FareStructureElement
​RefType · required

Reference to a resource available in a different APIs

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​PriceWithTax · required

Price with included tax amounts and an optional rate.

legIds
​string[] · required

The Leg IDs that are connected to this FareStructureElement

Default: []
​PurchasedParameters

Possible additional parameters for the configurations

The Geographical Interval with distance and zone data.

​RefType

Reference to a resource available in a different APIs

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.

​PurchasedProperties

Classification of the products chosen.

​PurchasedParameterSpecification[]

PurchasedValidableElement

Configuration for a ValidableElement
​RefType · required

Reference to a resource available in a different APIs

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​PriceWithTax · required

Price with included tax amounts and an optional rate.

legIds
​string[] · required

The Leg IDs that are connected to this ValidableElement.

Default: []
​PurchasedFareStructureElement[] · required

The underlying FareStructureElement configurations which makes up this ValidableElement

​PurchasedParameters

Possible additional parameters for the configurations

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
​PurchasedProperties

Classification of the products chosen.

occurs
​integer · int32

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

​PurchasedParameterSpecification[]

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

PurchasedFareProduct

Configuration for a purchased Fare Product
​RefType · required

Reference to a resource available in a different APIs

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​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: []
​PurchasedValidableElement[] · required

The ValidableElement configurations which makes up this FareProduct.

​PurchasedParameters

Possible additional parameters for the configurations

​OrganisationRef

The Organisation that owns the FareProduct

​PurchasedFareProduct

Configuration for a purchased Fare Product

originatingFromProductId
​string

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

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
​PurchasedSaleDiscountRight

Configuration for a Discount Right

​PurchasedProperties

Classification of the products chosen.

validityId
​string

Unique identifier for a purchased FareProduct with validity

amount
​integer · int32

Amount of priced unit

purchasedProductType
​PurchasedProductType · enum

Type of priced unit

Enum values:
TRIP_CARNET
PASS_CARNET
UNIT_COUPONS
STORED_VALUE
OTHER
​PurchasedParameterSpecification[]
fareAgreementNumber
​integer · int32

Fare agreement identifier

PurchasedDiscountUsageParameters

Possible additional parameters for the configurations
​PurchasedUsageParameter[] · required

Reference to reserving parameters with price information.

Default: []
​PurchasedUsageParameter[] · required

Reference to entitlement products used when calculating price

Default: []

PurchasedSaleDiscountRight

Configuration for a Discount Right
​RefType · required

Reference to a resource available in a different APIs

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​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

PurchasedProductType

string · enum
Enum values:
TRIP_CARNET
PASS_CARNET
UNIT_COUPONS
STORED_VALUE
OTHER

Type of priced unit

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

Mode

string · enum
Enum values:
AIR
BICYCLE
BUS
CABLEWAY
CAR
WATER
FUNICULAR
LIFT

Travel mode for Leg.

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

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

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.
originalFromStopPlaceRef
​string · required

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

originalToStopPlaceRef
​string · required

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

PurchasedLeg

Part of a trip between two places.
id
​string · required
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

endTime
​string · date-time · required

The date and time this Leg ends.

Example: 2023-10-12T15:00: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

mode
​Mode · enum · required

Travel mode for Leg.

Enum values:
AIR
BICYCLE
BUS
CABLEWAY
CAR
WATER
FUNICULAR
LIFT
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
​RefType

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

organisationId
​integer · int64

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

Example: 1234
​InterchangeTo

Connected ServiceJourneys without changing material

lineId
​string

Line ID

Example: ENT:Line:1
serviceJourneyPrivateCode
​string

Private code of the ServiceJourney

Example: ENT-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.

PointToPointValidity

Start and StopPlaces where the entity is valid
fromPlace
​string · required

Valid from StopPlace

toPlace
​string · required

Valid to StopPlace

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: []

PurchasedFareProductValidity

The PointToPontValidity or ZonalValidity this FareProduct contains.
validityId
​string · required

Unique identifier for a purchased FareProduct with validity

​PointToPointValidity

Start and StopPlaces where the entity is valid

​ZonalValidity

Zones where the product is valid

DistanceUnit

string · enum
Enum values:
METER
KILOMETER

Unit of distance measurement.

Distance

A distance value with a unit.
value
​number · decimal · required

The distance value.

Example: 12.5
unit
​DistanceUnit · enum · required

Unit of distance measurement.

Enum values:
METER
KILOMETER

TravelSpecification

​PurchasedFareProductValidity[] · required

The FareProductValidities for a product.

Default: []

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

​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.

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
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
​Distance

A distance value with a unit.

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
​RefType

Reference to a resource available in a different APIs

PurchasedTraveller

Traveller for OrderLine
travellerId
​string · uuid · required

ID for Traveller

​Entitlement[] · required

Entitlement information for the customer and the OrderLine

Default: []
givenConsentId
​string

TravelDocumentDistributionAction

string · enum
Enum values:
ATTACH_FARE_CONTRACT_AND_ACTIVATE

TravelDocumentDetails

​RefType · required

Reference to a resource available in a different APIs

distributionAction
​TravelDocumentDistributionAction · enum · required
Enum values:
ATTACH_FARE_CONTRACT_AND_ACTIVATE

DistributionDetails

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

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

​RefType

Reference to a resource available in a different APIs

​TravelDocumentDetails
distributionHolderCustomerId
​string

Reference to a customer who will use the travel right

Example: 12345

OrderLineRequest

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​PurchasedFareProduct[] · required

The underlying FareProducts which make up this SalesPackage.

Default: []
​TextInLanguage[] · required

Description.

Default: []
​PurchasedTraveller[] · required

The Travellers that are to travel on this OrderLine.

Default: []
id
​string · uuid

Id for an OrderLine, required when updating orderLines

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

The original price, with tax, in the local currency of the tax country.

​RefType

Reference to a resource available in a different APIs

​PurchasedParameters

Possible additional parameters for the configurations

privateCode
​string

Private code.

​TravelSpecification
externalReference
​string

External reference to another system supplied by the client.

Example: 3N7URR0X
​DistributionDetails

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

​PurchasedProperties

Classification of the products chosen.

effectiveCancellationDate
​string · date-time

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

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

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

​PurchasedParameterSpecification[]
externalConfirmation
​string

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

OrderLine

id
​string · uuid · required

ID of OrderLine

Example: dd3e1d71-1c96-4b88-a683-538a8724ee0d
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
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
createdAt
​string · date-time · required

Timestamp for when the OrderLine was created.

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​PurchasedFareProduct[] · required

The underlying FareProducts which make up this SalesPackage.

Default: []
​TextInLanguage[] · required

Description.

Default: []
​PurchasedTraveller[] · required

The Travellers that are to travel on this OrderLine.

Default: []
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.

refunded
​boolean

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

​PurchasedParameterSpecification[]
​AddedBy

Metadata about who or what added the OrderLine.

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

The original price, with tax, in the local currency of the tax country.

​RefType

Reference to a resource available in a different APIs

​PurchasedParameters

Possible additional parameters for the configurations

privateCode
​string

Private code.

​TravelSpecification
externalReference
​string

External reference to another system supplied by the client.

Example: 3N7URR0X
​DistributionDetails

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

​PurchasedProperties

Classification of the products chosen.

effectiveCancellationDate
​string · date-time

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

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

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

externalConfirmation
​string

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

PaymentRef

References to Payments
orderVersion
​integer · int32 · required

Order version number this Payment confirmed.

Example: 2
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
paymentId
​integer · int64

Reference to the Payment.

Example: 12352
creditId
​integer · int64

Reference to the Credit.

Example: 2321
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

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

CustomerRef

Customer reference.
id
​string · required

ID for Customer

Example: 12345

TravellerRequest

A Traveller object which might hold a reference to a Customer

Customer reference.

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
​PriceWithTax · required

Price with included tax amounts and an optional rate.

type
​string · required

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

Example: REFUND
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: []
​RefType

Reference to a resource available in a different APIs

orderVersion
​integer · int32

The version of the Order this Fee is added to

Example: 2
​RefType

Reference to a resource available in a different APIs

Fee

Fee related to one or more OrderLines
id
​string · uuid · required

ID used to uniquely identify Fee if deletion is necessary

Example: dd3e1d71-1c96-4b88-a683-538a8724ee0d
​PriceWithTax · required

Price with included tax amounts and an optional rate.

type
​string · required

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

Example: REFUND
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: []
​RefType

Reference to a resource available in a different APIs

orderVersion
​integer · int32

The version of the Order this Fee is added to

Example: 2
​RefType

Reference to a resource available in a different APIs

ContactInfo

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

Customer reference.

​CustomerRef

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

OrderRequest

A purchase Order for one or more Travellers
​ContactInfo

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

externalReference
​string

External reference for Orders

Example: 3N7URR0X
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
​SpecialOrderCause

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

Order

A purchase Order for one or more Travellers
id
​string · required

ID of Order.

Example: 3N7URR0X
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
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
totalAmount
​string · required

The total amount due for this Order.

Default: 0.00
balance
​string · required

The balance amount for this Order.

Default: 0.00
totalTaxAmount
​string · required

The total tax amount for this Order.

Default: 0.00
currency
​string · required

The currency for this Order.

Default: NOK
​OrderLine[] · required

OrderLines in the given Order.

Default: []
​PaymentRef[] · required

Payment references used on this Order.

Default: []
​PurchasedReservation[] · required

Seating Reservations connected to this Order.

Default: []
​Traveller[] · required

Unique Travellers in this Order.

Default: []
organisationId
​integer · int64 · required

ID of the organisation which created/sold this Order.

Example: 1
createdAt
​string · date-time · required

Timestamp for when Order was created.

Example: 2020-05-13T07:19:30.389Z
​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
lastConfirmedAt
​string · date-time

Timestamp for when Order was last confirmed.

Example: 2020-05-13T07:19:30.389Z
pos
​string

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

Example: POS-123
distributionChannelId
​string

Distribution channel ID of request used when Order was created

Example: ENT:DistributionChannel:Sor
​ContactInfo

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

externalReference
​string

External reference for Orders

Example: 3N7URR0X
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
​SpecialOrderCause

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

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

ApiError

title
​string · required

Short, human-readable summary of the problem

timestamp
​string · date-time · required
status
​integer · int32 · required
error
​string · required
exception
​string · required
message
​string · required
path
​string · required

OrderCreateRequest

Optional configuration to use when creating an Order
​ContactInfo

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

currency
​string

The currency for this Order.

Default: NOK
externalReference
​string

External reference for Orders

Example: 3N7URR0X
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

ConfirmOrderLinesRequest

orderLineIds
​string[] · required

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

FailOrderRequest

orderLineIds
​string[] · required

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

Did you find what you were looking for?