Entur Developer
Reserve Offers
Reserve Offers

Schemas

Download schema

IdAndVersionRef

A holder for an id and version combination
id
​string · required

Id reference to an external entity

version
​string

Optional version reference to an external entity

CustomerEntitlement

A holder for a customers entitlements
​IdAndVersionRef · required

A holder for an id and version combination

contractId
​string · uuid

The id of a benefit-contract that gives a customer an entitlement

Example: 5d3e9d2c-f9ab-4dd0-a735-100886278e0b
​IdAndVersionRef

A holder for an id and version combination

Customer

A holder for a customer and entitlements used by the customer for the offer
customerId
​string · required

Customer id that will be linked to the order line created from the offer specified

Example: 1234567
​CustomerEntitlement[] · required

The entitlement data for a customer; used if the the offer is created with entitlements

Default: []

RefType

Versioned Reference to a resource
id
​string · required

Value to identify a given resource

version
​string

Optional version for a given resource

DistributionDetails

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

Versioned Reference to a resource

​RefType

Versioned Reference to a resource

​RefType

Versioned Reference to a resource

distributionHolderCustomerId
​string

The Entur customer id that will be linked to the distribution of the order line created

Example: 1234556

OfferConfiguration

The configuration-holder for an offer configuration
offerId
​string · uuid · required

The id of the offer that is used

Example: 5d3e9d2c-f9ab-4dd0-a735-100886278e0b
​CustomerEntitlement

A holder for a customers entitlements

​Customer[]

Customers with optional entitlement data; used to link travellers to order line and when offers are created with entitlements

Default: []
​DistributionDetails

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

externalReference
​string

External reference to an order line. Only used by external operators to identify order lines created by OfferConfigurations

selectableProductIds
​string[]

A list of ids for selected products. Duplicates are only supported for SupplementProducts which does not modify seating assignments for the PreassignedFareProduct

Default: []
selectedTravellerIds
​string[]

This field is used to specify which travellers will be included in the use of this offer. This field cannot be used in combination with count. It is validated against the travellers identified in the travellerMappings property of the selected Offer, as well as the legal number of UserProfiles per compartment when reserving a group product. When reserving a group product, validation is performed against the valid number of UserProfiles per compartment. When reserving regular products, a number of order lines will be made, corresponding to the number of selectedTravellerIds. Each order line will have one of the selectedTravellerIds.

Default: []

ReserveOffersRequest

The input-holder for reserving offers and add them to an existing order.
​OfferConfiguration[] · required

A list of offer configurations selected for purchase

orderId
​string

The offer to add the order to. If no orderId is specified, a new order is created

Example: ABCD1234

ReplacedOrderLineIds

A holder that combines orginal order line ids with those that replaces them
originalOrderLineIds
​string[] · required
replacedByOrderLineIds
​string[] · required

OrderLineIdsAndReservationIds

A wrapper that holds the resulting ids for newly created order lines, reservations and possible replacement order lines
orderId
​string · required
orderLineIds
​string[] · required
reservationIds
​string[] · required
​ReplacedOrderLineIds[] · required
Default: []

ApiError

timestamp
​string · date-time · required
status
​integer · int32 · required
title
​string · required

Short, human-readable summary of the problem

error
​string · required
exception
​string · required
message
​string · required
path
​string · required

ChangeOrderLinesConfiguration

The configuration-holder for an offer configuration
offerId
​string · uuid · required

The id of the offer that is used

Example: 5d3e9d2c-f9ab-4dd0-a735-100886278e0b
orderLineId
​string · required

The id of the OrderLine to replace. Multiple offer configurations may contain the same orderLineId if replacing the OrderLine with multiple offer configurations. In that case, selectedOrderLineIds must also be equal.

Example: 5d3e9d2c-f9ab-4dd0-a735-100886278e0b
​Customer[]

Customers with optional entitlement data; used to link travellers to order line and when offers are created with entitlements

Default: []
​DistributionDetails

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

externalReference
​string

External reference to an order line. Only used by external operators to identify order lines created by OfferConfigurations

selectableProductIds
​string[]

A list of ids for selected products. Duplicates are only supported for SupplementProducts which does not modify seating assignments for the PreassignedFareProduct

Default: []
selectedTravellerIds
​string[]

This field is used to specify which travellers will be included in the use of this offer. It is validated against the travellers identified in the travellerMappings property of the selected Offer, as well as the legal number of UserProfiles per compartment when reserving a group product. When reserving a group product, validation is performed against the valid number of UserProfiles per compartment. When reserving regular products, a number of order lines will be made, corresponding to the number of selectedTravellerIds. Each order line will have one of the selectedTravellerIds.

Default: []
selectedOrderLineIds
​string[]
Example: ["5d3e9d2c-f9ab-4dd0-a735-100886278e0b"]
Default: []

ChangeOrderLinesRequest

The holder for a change offer configuration.
orderId
​string · required

The order to add the offer(s) to

Example: ABCD1234
​ChangeOrderLinesConfiguration[] · required

A list of change offer configurations selected for purchase

refundPriceDifference
​boolean · required

Experimental value that is used to refund the price difference between the original purchase and the change, if the change is cheaper than the original product.

Default: false

SelectedProductConfiguration

Configuration for a selectable product from an offer
selectedProductId
​string · required

A selectable product id.

count
​integer · int32 · required

The number of times to add said product. Count will only be considered on a fare product level. Default 1

Default: 1

AddSupplementProductsConfiguration

The configuration-holder for an offer configuration
offerId
​string · uuid · required

The id of the offer that is used

Example: 5d3e9d2c-f9ab-4dd0-a735-100886278e0b
orderLineId
​string · required

The id of the order line to add supplement products to

Example: 5d3e9d2c-f9ab-4dd0-a735-100886278e0b
​SelectedProductConfiguration[] · required

A list of ids and counts for selected supplement product configurations. Count is only considered for fare products.

Default: []
​Customer[]

Customers with optional entitlement data; used to link travellers to order line and when offers are created with entitlements

Default: []

AddSupplementProductsRequest

The holder for an add supplement product configuration.
​AddSupplementProductsConfiguration[] · required

A list of supplement product configurations selected for purchase

orderId
​string · required

The order to add the supplement product(s) to

Example: ABCD1234

Fee

amount
​string · required
currency
​string · required

Option

id
​string · required
specifiedProducts
​string[] · required
Default: []
types
​string[] · required
Enum values:
ANY_PRODUCT
SAME_PRODUCT
DEPARTURE_SAME_DAY
DEPARTURE_ANY_DAY
SPECIFIED_PRODUCT
SPECIFIED_FARE_CLASS
SEAT_MAP
TRANSFER_TICKET
Default: []
version
​string · required
​Fee
legIds
​string[]
toFareClass
​string
validFrom
​string · date-time
validTo
​string · date-time

OrderLineOptions

Holder for possible change options for a given order line
orderLineId
​string · required
​Option[] · required

ChangeOption

orderId
​string · required
​OrderLineOptions[] · required

TextInLanguage

Contains a text value in a given language
lang
​string · required

The language of the text

value
​string · required

The value of the text in the given language

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

Example: 12
taxCode
​string

Tax code for this tax rate

Example: 12

TPPTravelSpecification

Optional travel information for the order lines to be created
aimedStartTime
​string · date-time

Timestamp used when determining the beginning of the product's validity.

Example: 2025-01-01T12:00:00Z
aimedEndTime
​string · date-time

Timestamp used when determining the end of the product's validity.

Example: 2025-01-01T12:00:00Z

UserProfile

​RefType · required

Versioned Reference to a resource

​TextInLanguage[] · minItems: 1 · unique · required

A human-readable list of names for the product

​PriceWithTax

Price with included tax amounts and an optional rate.

​PriceWithTax

Price with included tax amounts and an optional rate.

Parameters

Similar to OrderLine.fareProducts.parameters, but with additional fields for third party products.
​UserProfile

ThirdPartyProductConfiguration

The request object used to create a third party product
quantity
​integer · min: 1 · required

The amount of equal third party products to add to the order

Default: 1
​RefType · required

Versioned Reference to a resource

​TextInLanguage[] · minItems: 1 · unique · required

A human-readable list of names for the product

​PriceWithTax · required

Price with included tax amounts and an optional rate.

​PriceWithTax · required

Price with included tax amounts and an optional rate.

authorityId
​string

Owner of the product.

Example: ENT:Authority:ENT
externalReference
​string

External reference to an order line. Only used by external operators to identify order lines created by ThirdPartyProductConfigurations.

​object

A map of client provided data to be placed on the order line. No validation is performed, and no guarantee can be made about its contents.

customerIds
​string[]

Entur customer ids that will be linked to the order line created

Default: []
​TPPTravelSpecification

Optional travel information for the order lines to be created

​DistributionDetails

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

​Parameters

Similar to OrderLine.fareProducts.parameters, but with additional fields for third party products.

ReserveThirdPartyProductsRequest

The requested list of third party products to create and add to the order.
orderId
​string · required

The orderId the third party products belongs to.

Example: ABCD1234
​ThirdPartyProductConfiguration[] · minItems: 1 · unique · required

ReserveThirdPartyProductsResponse

The order lines created when reserving third party product on the given order
orderId
​string · required
orderLineIds
​string[] · required
Did you find what you were looking for?