Schemas
Option
idtypesversionspecifiedProductsRefType
idValue to identify a given resource
versionOptional version for a given resource
ApiError
patherrortitleShort, human-readable summary of the problem
statusmessageexceptiontimestampCustomer
customerIdCustomer id that will be linked to the order line created from the offer specified
The entitlement data for a customer; used if the the offer is created with entitlements
Parameters
UserProfile
A human-readable list of names for the product
Versioned Reference to a resource
Price with included tax amounts and an optional rate.
Price with included tax amounts and an optional rate.
ChangeOption
orderIdPriceWithTax
amountAmount including tax amount.
currencyCurrency
taxAmountTax amount
taxCodeTax code for this tax rate
taxRateTax rate
TextInLanguage
langThe language of the text
valueThe value of the text in the given language
IdAndVersionRef
idId reference to an external entity
versionOptional version reference to an external entity
OrderLineOptions
orderLineIdOfferConfiguration
offerIdThe id of the offer that is used
Customers with optional entitlement data; used to link travellers to order line and when offers are created with entitlements
externalReferenceExternal reference to an order line. Only used by external operators to identify order lines created by OfferConfigurations
A holder for a customers entitlements
Wrapper for references connected to distribution of travel rights and/or tickets
selectableProductIdsA list of ids for selected products. Duplicates are only supported for SupplementProducts which does not modify seating assignments for the PreassignedFareProduct
selectedTravellerIdsThis 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.
countDeprecated: Please use either selectedTravellerIds or multiple offer configurations, depending on your use case. Old description: The number of instances of the salespackage(s), represented in the offer, and customer combination one would like to purchase. Default value = 1. If set to anything other than 1 when orderLineId is set, the endpoint will return 400 bad request.
customerIdsDeprecated: Use customers to supply customer ids
orderLineIdPlease use /change-order-line instead. If replacing an order line, this is the id of the order line to replace
CustomerEntitlement
A holder for an id and version combination
contractIdThe id of a benefit-contract that gives a customer an entitlement
A holder for an id and version combination
DistributionDetails
ReplacedOrderLineIds
originalOrderLineIdsreplacedByOrderLineIdsReserveOffersRequest
A list of offer configurations selected for purchase
orderIdThe offer to add the order to. If no orderId is specified, a new order is created
TPPTravelSpecification
aimedEndTimeTimestamp used when determining the end of the product's validity.
aimedStartTimeTimestamp used when determining the beginning of the product's validity.
ChangeOrderLinesRequest
orderIdThe order to add the offer(s) to
A list of change offer configurations selected for purchase
refundPriceDifferenceExperimental 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.
AddSupplementProductsRequest
orderIdThe order to add the supplement product(s) to
A list of supplement product configurations selected for purchase
SelectedProductConfiguration
countThe number of times to add said product. Count will only be considered on a fare product level. Default 1
selectedProductIdA selectable product id.
ChangeOrderLinesConfiguration
offerIdThe id of the offer that is used
orderLineIdThe 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.
Customers with optional entitlement data; used to link travellers to order line and when offers are created with entitlements
externalReferenceExternal reference to an order line. Only used by external operators to identify order lines created by OfferConfigurations
Wrapper for references connected to distribution of travel rights and/or tickets
selectableProductIdsA list of ids for selected products. Duplicates are only supported for SupplementProducts which does not modify seating assignments for the PreassignedFareProduct
selectedOrderLineIdsselectedTravellerIdsThis 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.
OrderLineIdsAndReservationIds
orderIdorderLineIdsreservationIdsThirdPartyProductConfiguration
A human-readable list of names for the product
Price with included tax amounts and an optional rate.
quantityThe amount of equal third party products to add to the order
Versioned Reference to a resource
Price with included tax amounts and an optional rate.
Similar to OrderLine.fareProducts.parameters, but with additional fields for third party products.
authorityIdOwner of the product.
customerIdsEntur customer ids that will be linked to the order line created
externalReferenceExternal reference to an order line. Only used by external operators to identify order lines created by ThirdPartyProductConfigurations.
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.
Wrapper for references connected to distribution of travel rights and/or tickets
Optional travel information for the order lines to be created
ReserveThirdPartyProductsRequest
orderIdThe orderId the third party products belongs to.
ReserveThirdPartyProductsResponse
orderIdorderLineIdsAddSupplementProductsConfiguration
offerIdThe id of the offer that is used
orderLineIdThe id of the order line to add supplement products to
A list of ids and counts for selected supplement product configurations. Count is only considered for fare products.
Customers with optional entitlement data; used to link travellers to order line and when offers are created with entitlements