Entur Developer
Product Parameters
Product Parameters

Schemas

Download schema

PageInfo

Paging information shared by all paginated list responses.
totalCount
​integer · required

Total number of elements matching the query.

Example: 5
page
​integer · required

Current zero-based page number.

Example: 0
size
​integer · required

Requested page size.

Example: 100

LocalizedString

​object[]
lang
​string · pattern: ^[a-z]{2}-[A-Z]{2}$ · required

BCP-47 language tag (e.g., 'nb-NO', 'en-GB').

Example: nb-NO
value
​string · required

The localized string value for the specified lang.

VersionStatus

string · enum
Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED

VersionSummary

A light summary of one version of a versioned element, as shown in lists. Shared by the list endpoints of all element types.
versionId
​string · pattern: ^([A-Z]{3}):Version:… · required

NeTEx id of the version.

Example: ENT:Version:8f1b2c3d
​object[] · required
startDate
​string · date · required

First day the version is valid.

Example: 2026-08-01
status
​VersionStatus · enum · required
Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
versionNumber
​integer · int64

Sequence number of the version, when assigned.

Example: 1
endDate
​string · date

First day the version is no longer valid (optional).

Example: 2026-12-31

VersionedElementSummary

A versioned element with the versions relevant today, as shown in lists. Shared by the list endpoints of all element types. The versions are: - VERSIONED versions valid today or in the future (no end date, or an end date after today) - DRAFT and PROPOSED versions, regardless of date - when deprecated versions are requested, the most recent DEPRECATED version (latest start date) ordered by status (DRAFT, PROPOSED, VERSIONED, DEPRECATED) and then by start date, newest first.
id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required

NeTEx id of the element.

Example: ENT:PurchaseWindow:90days
ownerOrganisationId
​integer · int64 · required

Internal organisation id owning the element.

Example: 1
​VersionSummary[] · required

PurchaseWindowListResponse

A page of purchase windows, each with the versions relevant today.
totalCount
​integer · required

Total number of elements matching the query.

Example: 5
page
​integer · required

Current zero-based page number.

Example: 0
size
​integer · required

Requested page size.

Example: 100
​VersionedElementSummary[] · required

The purchase windows on this page, ordered by id.

ProblemDetails

RFC 9457 Problem Details
type
​string · uri · required

A URI reference that identifies the problem type.

Example: https://developer.entur.org/errors/bad-request
title
​string · required

Short, human-readable summary of the problem type.

Example: Bad Request
status
​integer · int32 · required

The HTTP status code.

Example: 400
detail
​string · required

Human-readable explanation specific to this occurrence.

Example: The supplied ruleId is not a valid UUID.
instance
​string · uri

A URI reference that identifies the specific occurrence.

Example: https://api.example.com/requests/12345

PurchaseWhen

string · enum
Enum values:
ADVANCE_ONLY
UNTIL_PREVIOUS_DAY
DAY_OF_TRAVEL_ONLY
ADVANCE_AND_DAY_OF_TRAVEL
TIME_OF_TRAVEL_ONLY
SUBSCRIPTION_CHARGE_MOMENT
OTHER

When a purchase can be made relative to the time of travel.

  • ADVANCE_ONLY - Only in advance of the day of travel.
  • UNTIL_PREVIOUS_DAY - Until the end of the day before travel.
  • DAY_OF_TRAVEL_ONLY - Only on the day of travel.
  • ADVANCE_AND_DAY_OF_TRAVEL - In advance or on the day of travel.
  • TIME_OF_TRAVEL_ONLY - Only at the time of travel.
  • SUBSCRIPTION_CHARGE_MOMENT - At the charge moment of a subscription.
  • OTHER - Other rule.

PurchaseAction

string · enum
Enum values:
PURCHASE
ORDER_WITHOUT_PAYMENT
RESERVE
PAY_FOR_PREVIOUS_ORDER
SUBSCRIBE
PAY_INSTALLMENT
OTHER

The type of purchase action the window applies to.

PurchaseMoment

string · enum
Enum values:
ON_RESERVATION
IN_ADVANCE
IN_ADVANCE_ONLY
BEFORE_BOARDING
BEFORE_BOARDING_ONLY
ON_BOARDING
ON_BOARDING_ONLY
AFTER_BOARDING

A moment at which a purchase can be made.

PurchaseWindowRequest

A purchase window (NeTEx `PurchaseWindow`, a `UsageParameter`) defines when a product can be purchased relative to the time of travel. Products reference it through `purchaseWindowRef`; the underlying NeTEx `GenericParameterAssignment` is managed by the backend.
​object[] · required
startDate
​string · date · required

First day this purchase window version is valid.

Example: 2026-08-01
status
​string · enum · required

Status of the purchase window version. Required; on create only DRAFT or PROPOSED is accepted — a new version cannot be published directly.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
Example: DRAFT
ownerOrganisationId
​integer · int64 · min: 1

Internal id of the organisation that owns this element. Omit it to use the organisation in the access token, which is what a caller acting for itself should do. Supplying a different organisation requires permission to act on behalf of that organisation.

Example: 1
​object[]
endDate
​string · date

Last day this purchase window version is valid (optional). Omit for an open-ended version.

Example: 2026-12-31
purchaseWhen
​string · enum

When a purchase can be made relative to the time of travel.

  • ADVANCE_ONLY - Only in advance of the day of travel.
  • UNTIL_PREVIOUS_DAY - Until the end of the day before travel.
  • DAY_OF_TRAVEL_ONLY - Only on the day of travel.
  • ADVANCE_AND_DAY_OF_TRAVEL - In advance or on the day of travel.
  • TIME_OF_TRAVEL_ONLY - Only at the time of travel.
  • SUBSCRIPTION_CHARGE_MOMENT - At the charge moment of a subscription.
  • OTHER - Other rule.
Enum values:
ADVANCE_ONLY
UNTIL_PREVIOUS_DAY
DAY_OF_TRAVEL_ONLY
ADVANCE_AND_DAY_OF_TRAVEL
TIME_OF_TRAVEL_ONLY
SUBSCRIPTION_CHARGE_MOMENT
OTHER
latestTime
​string · pattern: ^([01][0-9]|2[0-3]):…

Latest time of day a purchase can be made (NeTEx LatestTime), formatted HH:mm:ss.

Example: 23:59:59
minimumPeriodBeforeDeparture
​string

Minimum period before departure that a purchase must be made (NeTEx MinimumPeriodBeforeDeparture). ISO 8601 duration with days, hours, minutes and/or seconds.

Example: PT1H
maximumPeriodBeforeDeparture
​string

Maximum period before departure that a purchase can be made (NeTEx MaximumPeriodBeforeDeparture). ISO 8601 duration with days, hours, minutes and/or seconds. Must not be shorter than minimumPeriodBeforeDeparture.

Example: P90D
purchaseAction
​string · enum

The type of purchase action the window applies to.

Enum values:
PURCHASE
ORDER_WITHOUT_PAYMENT
RESERVE
PAY_FOR_PREVIOUS_ORDER
SUBSCRIBE
PAY_INSTALLMENT
OTHER
purchaseMoments
​PurchaseMoment[] · unique

The moments at which a purchase can be made (NeTEx PurchaseMoment, a list).

Enum values:
ON_RESERVATION
IN_ADVANCE
IN_ADVANCE_ONLY
BEFORE_BOARDING
BEFORE_BOARDING_ONLY
ON_BOARDING
ON_BOARDING_ONLY
AFTER_BOARDING

PurchaseWindowResponse

id
​string · pattern: ^([A-Z]{3}):Purchase… · required

NeTEx id of the purchase window.

Example: ENT:PurchaseWindow:90days
versionId
​string · pattern: ^([A-Z]{3}):Version:… · required

NeTEx id of this purchase window version.

Example: ENT:Version:8f1b2c3d
ownerOrganisationId
​integer · int64 · required

Internal organisation id owning this purchase window.

Example: 1
​object[] · required
startDate
​string · date · required

First day this purchase window version is valid.

Example: 2026-08-01
status
​VersionStatus · enum · required
Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
versionNumber
​integer · int64

Sequence number of this version, when assigned.

Example: 1
​object[]
endDate
​string · date

Last day this purchase window version is valid (optional).

Example: 2026-12-31
purchaseWhen
​string · enum

When a purchase can be made relative to the time of travel.

  • ADVANCE_ONLY - Only in advance of the day of travel.
  • UNTIL_PREVIOUS_DAY - Until the end of the day before travel.
  • DAY_OF_TRAVEL_ONLY - Only on the day of travel.
  • ADVANCE_AND_DAY_OF_TRAVEL - In advance or on the day of travel.
  • TIME_OF_TRAVEL_ONLY - Only at the time of travel.
  • SUBSCRIPTION_CHARGE_MOMENT - At the charge moment of a subscription.
  • OTHER - Other rule.
Enum values:
ADVANCE_ONLY
UNTIL_PREVIOUS_DAY
DAY_OF_TRAVEL_ONLY
ADVANCE_AND_DAY_OF_TRAVEL
TIME_OF_TRAVEL_ONLY
SUBSCRIPTION_CHARGE_MOMENT
OTHER
latestTime
​string

Latest time of day a purchase can be made (NeTEx LatestTime), formatted HH:mm:ss.

Example: 23:59:59
minimumPeriodBeforeDeparture
​string

Minimum period before departure (NeTEx MinimumPeriodBeforeDeparture). ISO 8601 duration.

Example: PT1H
maximumPeriodBeforeDeparture
​string

Maximum period before departure (NeTEx MaximumPeriodBeforeDeparture). ISO 8601 duration.

Example: P90D
purchaseAction
​string · enum

The type of purchase action the window applies to.

Enum values:
PURCHASE
ORDER_WITHOUT_PAYMENT
RESERVE
PAY_FOR_PREVIOUS_ORDER
SUBSCRIBE
PAY_INSTALLMENT
OTHER
purchaseMoments
​PurchaseMoment[]

The moments at which a purchase can be made (NeTEx PurchaseMoment).

Enum values:
ON_RESERVATION
IN_ADVANCE
IN_ADVANCE_ONLY
BEFORE_BOARDING
BEFORE_BOARDING_ONLY
ON_BOARDING
ON_BOARDING_ONLY
AFTER_BOARDING
Default: []

VersionResponse

id
​string · pattern: ^([A-Z]{3}):Version:… · required

The netex id reference to the object.

Example: EXA:Version:001
status
​VersionStatus · enum · required
Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
startDate
​string · date · required

The start date of the version.

created
​string · date-time · required

Created datetime

changed
​string · date-time · required

Changed datetime

number
​integer · int64

Version number of the version. Only present when versionStatus is VERSIONED. Starts at 1 for a new product and is incremented by 1 for each new version.

Example: 1
endDate
​string · date

The end date of the version.

published
​string · date-time

Timestamp for when the version was published (set to status VERSIONED).

VersionRequest

status
​string · enum · required

Must be DRAFT for new versions.

Enum values:
DRAFT
PROPOSED
VERSIONED
DEPRECATED
startDate
​string · date · required

The start date of the version. Defaults to current date if not provided.

endDate
​string · date

The end date of the version (optional).

ownerOrganisationId
​integer · int64 · min: 1

Internal id of the organisation that owns this element. Omit it to use the organisation in the access token, which is what a caller acting for itself should do. Supplying a different organisation requires permission to act on behalf of that organisation.

Did you find what you were looking for?