openapi: 3.2.0 info: title: Entur Reserving API version: 2026.10.0 description: 'Operations tagged reserving across 2 of this provider''s published API definitions: entur-products-openapi.json, entur-products-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.entur.io/products description: Production environment - url: https://api.staging.entur.io/products description: Staging environment - url: https://api.dev.entur.io/products description: Development environment security: - jwt: [] tags: - name: reserving paths: /reserving: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' get: tags: - reserving summary: Retrieves all reserving rules operationId: reserving_getAll parameters: - name: orgId in: query description: The unique id to identify an organisation required: false style: form explode: true schema: type: string - name: fareFrameId in: query description: The unique id to identify dataset to an organization required: false style: form explode: true schema: type: string - name: languageCode in: query description: The language code from ISO-639-3 required: false style: form explode: true schema: type: string - name: If-None-Match in: header description: Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource. required: false style: simple explode: false schema: type: string responses: '200': description: Returns the info content: application/json: schema: $ref: '#/components/schemas/Reserving' '304': description: Not Modified '400': description: Bad Request content: application/problem+json: schema: type: string '401': description: Missing Authorization content: application/problem+json: schema: type: string '403': description: Authorization failed content: application/problem+json: schema: type: string '404': description: Resource not found content: application/problem+json: schema: type: string '500': description: Internal server error content: application/problem+json: schema: type: string security: - basic_auth: [] x-entur-permissions: value: product-api-access:les post: tags: - reserving summary: Create a reserving rule operationId: reserving_create parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservingInsert' required: true responses: '204': description: Entity created successfully content: application/json: schema: $ref: '#/components/schemas/BoxedUnit' '400': description: Validation errors content: application/problem+json: schema: type: string '401': description: Unauthorized content: application/problem+json: schema: type: string '403': description: Forbidden content: application/problem+json: schema: type: string '404': description: Not Found content: application/problem+json: schema: type: string '409': description: Already registered content: application/problem+json: schema: type: string '500': description: Internal server error content: application/problem+json: schema: type: string security: - basic_auth: [] x-entur-permissions: value: product-api-access:endre servers: - url: https://api.entur.io/products description: Production environment - url: https://api.staging.entur.io/products description: Staging environment - url: https://api.dev.entur.io/products description: Development environment /reserving/{id}: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' get: tags: - reserving summary: Retrieves a reserving rule by ID operationId: reserving_getById parameters: - name: id in: path description: The unique ID to identify a reserving. required: true style: simple explode: false schema: pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string - name: version in: query description: The ID for the version of the reservation. required: false style: form explode: true schema: type: string - name: languageCode in: query description: The language code from ISO-639-3. required: false style: form explode: true schema: type: string - name: If-None-Match in: header description: Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource. required: false style: simple explode: false schema: type: string responses: '200': description: Returns the reserving. content: application/json: schema: $ref: '#/components/schemas/Reserving' '304': description: Not Modified '400': description: Bad Request content: application/problem+json: schema: type: string '401': description: Unauthorized content: application/problem+json: schema: type: string '403': description: Forbidden content: application/problem+json: schema: type: string '404': description: Resource not found. content: application/problem+json: schema: type: string '500': description: Internal server error. content: application/problem+json: schema: type: string security: - basic_auth: [] x-entur-permissions: value: product-api-access:les servers: - url: https://api.entur.io/products description: Production environment - url: https://api.staging.entur.io/products description: Staging environment - url: https://api.dev.entur.io/products description: Development environment /reserving/{id}/{version}: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' get: tags: - reserving summary: Retrieves a reserving rule by id and version operationId: reserving_getByIdAndVersion parameters: - name: id in: path description: The unique ID to identify a reserving. required: true style: simple explode: false schema: pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string - name: version in: path description: The ID for the version of the reservation. required: true style: simple explode: false schema: pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string - name: Accept-Language in: header description: The language code from ISO-639-3 required: false style: simple explode: false schema: type: string - name: If-None-Match in: header description: Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource. required: false style: simple explode: false schema: type: string responses: '200': description: Returns the reserving. content: application/json: schema: $ref: '#/components/schemas/Reserving' '304': description: Not Modified '400': description: Bad Request content: application/problem+json: schema: type: string '401': description: Unauthorized content: application/problem+json: schema: type: string '403': description: Forbidden content: application/problem+json: schema: type: string '404': description: Resource not found. content: application/problem+json: schema: type: string '500': description: Internal server error. content: application/problem+json: schema: type: string security: - basic_auth: [] x-entur-permissions: value: product-api-access:les put: tags: - reserving summary: Update a reserving rule operationId: reserving_update parameters: - name: id in: path description: The unique ID to identify a reserving. required: true style: simple explode: false schema: pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string - name: version in: path description: The ID for the version of the reservation. required: true style: simple explode: false schema: pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReservingInsert' required: true responses: '204': description: Entity updated successfully '400': description: Validation errors content: application/problem+json: schema: type: string '401': description: Missing Authorization content: application/problem+json: schema: type: string '403': description: Authorization failed content: application/problem+json: schema: type: string '404': description: Resource not found content: application/problem+json: schema: type: string '409': description: Conflict content: application/problem+json: schema: type: string '500': description: Internal server error content: application/problem+json: schema: type: string security: - basic_auth: [] x-entur-permissions: value: product-api-access:endre servers: - url: https://api.entur.io/products description: Production environment - url: https://api.staging.entur.io/products description: Staging environment - url: https://api.dev.entur.io/products description: Development environment /v1/reserving/{id}: parameters: - $ref: '#/components/parameters/ET-Client-Name' - $ref: '#/components/parameters/X-Correlation-Id' get: tags: - reserving summary: Retrieves a reserving rule by ID operationId: reserving_getByIdV2 parameters: - name: id in: path description: The unique ID to identify a reserving. required: true style: simple explode: false schema: pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string - name: Accept-Language in: header description: The language code from ISO-639-3. required: false style: simple explode: false schema: type: string - name: startDate in: query required: false style: form explode: true schema: type: string - name: endDate in: query required: false style: form explode: true schema: type: string - name: status in: query description: The version status of the reserving rule. required: false style: form explode: true schema: type: string - name: fromDate in: query description: The from date of the reserving rule version. required: false style: form explode: true schema: type: string - name: toDate in: query description: The to date of the reserving rule version. required: false style: form explode: true schema: type: string - name: If-None-Match in: header description: Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource. required: false style: simple explode: false schema: type: string responses: '200': description: Returns the reserving rule. content: application/json: schema: type: array items: $ref: '#/components/schemas/Reserving' '304': description: Not Modified '400': description: Bad Request content: application/problem+json: schema: type: string '401': description: Unauthorized content: application/problem+json: schema: type: string '403': description: Forbidden content: application/problem+json: schema: type: string '404': description: Resource not found. content: application/problem+json: schema: type: string '500': description: Internal server error. content: application/problem+json: schema: type: string security: - basic_auth: [] x-entur-permissions: value: product-api-access:les servers: - url: https://api.entur.io/products description: Production environment - url: https://api.staging.entur.io/products description: Staging environment - url: https://api.dev.entur.io/products description: Development environment components: schemas: VersionOfObjectRef: required: - nameOfClass - ref - version type: object properties: nameOfClass: minLength: 1 type: string description: Name of class. ref: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: The netex id reference to the object. version: type: string description: Version. description: Fare frame ref. FarePrice: required: - changed - created - fareFrameRef - id - modification - nameOfClass - status type: object properties: amount: type: string description: Amount examples: - '164.0' canBeCumulative: type: boolean description: canBeCumulative. examples: - true changed: type: string description: Changed datetime. readOnly: true compatibleWithVersionRef: type: string description: Compatible with version. created: type: string description: Created datetime. readOnly: true currency: type: string description: Currency. examples: - NOK derivedFromVersionRef: type: string description: Derived from version. discountPercentageUsed: maximum: 100 minimum: -100 type: integer description: discountPercentageUsed. format: int32 examples: - 5 fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 type: string description: Id. examples: - NSB:FarePrice:1005TEN isAllowed: type: boolean description: isAllowed. examples: - true limitingRule: $ref: '#/components/schemas/LimitingRule' modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. readOnly: true examples: - FarePrice ranking: type: integer description: Ranking. format: int32 examples: - 1 rounding: $ref: '#/components/schemas/Rounding' roundingRef: $ref: '#/components/schemas/VersionOfObjectRef' status: type: string description: Status. readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT vatRegisterGroup: type: string description: vatRegisterGroup. enum: - EXCEPTION_FROM_VAT - GENERAL_VAT - FOOD_VAT - TRANSPORT_AND_TICKETS_VAT examples: - TRANSPORT_AND_TICKETS_VAT version: type: string description: Version. readOnly: true examples: - NSB:Version:V1 description: A description of the price and factor for a set fare LimitingRule: required: - changed - created - fareFrameRef - id - modification - nameOfClass - status type: object properties: canBeCumulative: type: boolean description: CanBeCumulative. changed: type: string description: Changed datetime. readOnly: true compatibleWithVersionRef: type: string description: Compatible with version. created: type: string description: Created datetime. readOnly: true derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description. items: $ref: '#/components/schemas/TextInLanguage' discountAsPercentage: type: number description: DiscountAsPercentage. format: float discountAsValue: type: number description: DiscountAsValue. format: float fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. maximumPrice: type: string description: MaximumPrice. examples: - '164.0' maximumPriceAsPercentage: type: number description: MaximumPriceAsPercentage. format: double minimumLimitPrice: type: string description: MinimumLimitPrice. examples: - '164.0' minimumPrice: type: string description: MinimumPrice. examples: - '164.0' modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. readOnly: true examples: - LimitingRule status: type: string description: Status. readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Version. examples: - NSB:Version:V1 description: A LimitingRule ReservingInsert: required: - fareFrameRef - id - name - version type: object properties: description: type: array description: Description represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' feeBasis: type: string description: Fee basis. enum: - PER_OFFER - PER_PERSON examples: - PER_OFFER id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:Reserving:SeatAsAccommodationReserving maximumNumberToReserve: type: integer description: Maximum amount to reserve. format: int32 minimumNumberToReserve: type: integer description: Minimum amount to reserve. format: int32 mustReserveWholeCompartment: type: boolean description: Must reserve whole compartment name: type: array description: Name represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' prices: type: array description: Prices for the reserving. items: $ref: '#/components/schemas/FarePrice' reservationChargeType: type: string description: Type of charge for reservation. enum: - NONE - SINGLE_FEE_FOR_RETURN_TRIP - FEE_FOR_EACH_DIRECTION - FEE_FOR_EACH_LEG examples: - NONE reservingRequirements: type: string description: Requirements for reservation. enum: - RESERVATIONS_COMPULSORY - RESERVATIONS_COMPULSORY_FOR_GROUPS - RESERVATIONS_COMPULSORY_FOR_FIRST_CLASS - RESERVATIONS_COMPULSORY_FROM_ORIGIN_STATION - RESERVATIONS_RECOMMENDED - RESERVATIONS_POSSIBLE - RESERVATIONS_POSSIBLE_ONLY_IN_FIRST_CLASS - RESERVATIONS_POSSIBLE_ONLY_IN_SECOND_CLASS - RESERVATIONS_POSSIBLE_FOR_CERTAIN_CLASSES - GROUP_BOOKING_RESTRICTED - NO_GROUPS_ALLOWED - NO_RESERVATIONS_POSSIBLE - WHEELCHAIR_ONLY_RESERVATIONS - BICYCLE_RESERVATIONS_COMPULSORY - RESERVATION_SUPPLEMENT_CHARGED examples: - RESERVATIONS_COMPULSORY typeOfUsageParameter: type: string description: Type of usage parameter for the reservation. examples: - NSB:TypeOfUsageParameter:ThroughFareInterchanging version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Reserving version. examples: - NSB:Version:V1 TextInLanguage: required: - lang - value type: object properties: lang: minLength: 1 type: string description: Language code. examples: - nob value: minLength: 1 type: string description: The text. description: Text in a specific language. BoxedUnit: type: object Reserving: required: - changed - created - fareFrameRef - fareTableRefs - id - modification - nameOfClass - status - version type: object properties: changed: type: string description: Changed datetime. compatibleWithVersionRef: type: string description: Compatible with version. created: type: string description: Created datetime. derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' fareTableRefs: type: array description: References for associated fare tables. items: $ref: '#/components/schemas/VersionOfObjectRef' feeBasis: type: string description: Fee basis. enum: - PER_OFFER - PER_PERSON examples: - PER_OFFER id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:Reserving:SeatAsAccommodationReserving limitingRule: $ref: '#/components/schemas/LimitingRule' limitingRuleRef: $ref: '#/components/schemas/VersionOfObjectRef' maximumNumberToReserve: type: integer description: Maximum amount to reserve. format: int32 minimumNumberToReserve: type: integer description: Minimum amount to reserve. format: int32 modification: type: string description: Modification status. enum: - NEW - REVISE - DELETE examples: - NEW mustReserveWholeCompartment: type: boolean description: Must reserve whole compartment name: type: array description: Name represented in different languages. Language codes are ISO-639. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. examples: - Reserving prices: type: array description: Prices in different currencies for the reserving rule. items: $ref: '#/components/schemas/FarePrice' reservationChargeType: type: string description: Type of charge for reservation. enum: - NONE - SINGLE_FEE_FOR_RETURN_TRIP - FEE_FOR_EACH_DIRECTION - FEE_FOR_EACH_LEG examples: - NONE reservingRequirements: type: string description: Requirements for reservation. enum: - RESERVATIONS_COMPULSORY - RESERVATIONS_COMPULSORY_FOR_GROUPS - RESERVATIONS_COMPULSORY_FOR_FIRST_CLASS - RESERVATIONS_COMPULSORY_FROM_ORIGIN_STATION - RESERVATIONS_RECOMMENDED - RESERVATIONS_POSSIBLE - RESERVATIONS_POSSIBLE_ONLY_IN_FIRST_CLASS - RESERVATIONS_POSSIBLE_ONLY_IN_SECOND_CLASS - RESERVATIONS_POSSIBLE_FOR_CERTAIN_CLASSES - GROUP_BOOKING_RESTRICTED - NO_GROUPS_ALLOWED - NO_RESERVATIONS_POSSIBLE - WHEELCHAIR_ONLY_RESERVATIONS - BICYCLE_RESERVATIONS_COMPULSORY - RESERVATION_SUPPLEMENT_CHARGED examples: - RESERVATIONS_COMPULSORY status: type: string description: Reserving status. enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT typeOfUsageParameter: type: string description: Type of usage parameter for the reservation. examples: - NSB:TypeOfUsageParameter:OpenSeating version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Reserving version. examples: - NSB:Version:V1 description: Reserving Rounding: required: - changed - created - fareFrameRef - id - modification - nameOfClass - roundingMethod - status - version type: object properties: changed: type: string description: Changed datetime. readOnly: true compatibleWithVersionRef: type: string description: Compatible with version. created: type: string description: Created datetime. readOnly: true derivedFromVersionRef: type: string description: Derived from version. description: type: array description: Description. items: $ref: '#/components/schemas/TextInLanguage' fareFrameRef: $ref: '#/components/schemas/VersionOfObjectRef' id: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Id. examples: - NSB:Rounding:Ordinary modification: type: string description: Modification status. readOnly: true enum: - NEW - REVISE - DELETE examples: - NEW name: type: array description: Name. items: $ref: '#/components/schemas/TextInLanguage' nameOfClass: type: string description: Name of class. readOnly: true examples: - Rounding roundingMethod: type: string description: Type of rounding. enum: - NONE - DOWN - UP - SPLIT - STEP_TABLE - FIVE - NINE - TEN - FORTY_NINE roundingModulus: type: number description: Amount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value. format: double status: type: string description: Rounding status. readOnly: true enum: - DRAFT - PROPOSED - VERSIONED - DEPRECATED examples: - DRAFT version: minLength: 1 pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$ type: string description: Rounding version. examples: - NSB:Version:V1 description: A description of how prices are rounded post calculation deprecated: true parameters: X-Correlation-Id: name: X-Correlation-Id in: header description: Correlation id required: false style: simple explode: false schema: type: string ET-Client-Name: name: ET-Client-Name in: header description: 'Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: `-`.' required: false style: simple explode: false schema: type: string securitySchemes: jwt: type: http scheme: bearer bearerFormat: JWT x-refined-from: - entur-products-openapi.json - entur-products-openapi.yml