Entur Developer
Product Parameters
Product Parameters

Purchase window

Server
Download schema

A purchase window defines when a product can be purchased relative to the time of travel — for example up to 90 days before and at least one hour before departure, or only until the day before travel. Products reference it through purchaseWindowRef.

List purchase windows with their current versions

GET
https://api.entur.io/products
/v3/parameters/purchase-windows

Returns a paginated list of purchase windows, ordered by id. Each entry is a light summary (VersionedElementSummary, shared with other element types) with the purchase window id and the versions that are relevant today:

  • VERSIONED versions valid today or in the future (no end date, or an end date after today)
  • DRAFT and PROPOSED versions, regardless of date
  • with includeDeprecated=true, also the most recent DEPRECATED version (latest start date)

Versions are ordered by status (DRAFT, PROPOSED, VERSIONED, DEPRECATED) and then by start date, newest first. Purchase windows without any such version are left out. Paging is per purchase window, so the versions of one purchase window are never split across pages.

All versions of a single purchase window are available through GET /v3/parameters/purchase-windows/{id}/versions, and the full content of a version through GET /v3/parameters/purchase-windows/{id}/{version}.

List purchase windows with their current versions › query Parameters

page
​integer · min: 0 · style: form · explode: true

Zero-based page number. Defaults to 0.

Default: 0
size
​integer · min: 1 · max: 1000 · style: form · explode: true

Number of instances per page. Defaults to 100.

Default: 100
includeDeprecated
​boolean · style: form · explode: true

Also include the most recent DEPRECATED version of each purchase window.

Default: false
ownerOrganisationId
​integer · int64 · style: form · explode: true

Only return purchase windows owned by this internal organisation id.

List purchase windows with their current versions › Headers

ET-Client-Name
​string · style: simple

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: <company>-<application>.

X-Correlation-Id
​string · style: simple

Correlation id

List purchase windows with their current versions › Responses

Paginated list of purchase window summaries

A page of purchase windows, each with the versions relevant today.
PurchaseWindowListResponse
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.

Create a new purchase window

POST
https://api.entur.io/products
/v3/parameters/purchase-windows

Create a new purchase window. A new version is created together with it.

Create a new purchase window › Headers

ET-Client-Name
​string · style: simple

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: <company>-<application>.

X-Correlation-Id
​string · style: simple

Correlation id

Create a new purchase window › Request Body

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

Create a new purchase window › Responses

Purchase window created successfully

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

Get the active version of a purchase window

GET
https://api.entur.io/products
/v3/parameters/purchase-windows/{id}

Retrieve the version of the purchase window that is active on the given date. Defaults to the version active today when no date is given.

Get the active version of a purchase window › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The netex ID of the element to retrieve

Get the active version of a purchase window › query Parameters

validOnDate
​string · date · style: form · explode: true

The date that the element should be valid for, e.g. the travel date. Defaults to the current date.

Get the active version of a purchase window › Headers

ET-Client-Name
​string · style: simple

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: <company>-<application>.

X-Correlation-Id
​string · style: simple

Correlation id

Get the active version of a purchase window › Responses

The purchase window version active on the given date.

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

Create a new version of an existing purchase window

POST
https://api.entur.io/products
/v3/parameters/purchase-windows/{id}

Create a new version of an existing purchase window. Products referencing the purchase window are not modified: they point at its id, and the effective version is resolved by validity period.

Create a new version of an existing purchase window › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The netex ID of the element to retrieve

Create a new version of an existing purchase window › Headers

ET-Client-Name
​string · style: simple

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: <company>-<application>.

X-Correlation-Id
​string · style: simple

Correlation id

Create a new version of an existing purchase window › Request Body

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

Create a new version of an existing purchase window › Responses

Purchase window version created successfully

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

List versions of a purchase window

GET
https://api.entur.io/products
/v3/parameters/purchase-windows/{id}/versions

Retrieve all versions of a purchase window by its NeTEx ID, including drafts and proposals.

List versions of a purchase window › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The netex ID of the element to retrieve

List versions of a purchase window › Headers

ET-Client-Name
​string · style: simple

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: <company>-<application>.

X-Correlation-Id
​string · style: simple

Correlation id

List versions of a purchase window › Responses

List of purchase window versions

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

Get a specific purchase window version

GET
https://api.entur.io/products
/v3/parameters/purchase-windows/{id}/{version}

Retrieve a specific version of a purchase window, identified by NeTEx version id or version number.

Get a specific purchase window version › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The netex ID of the element to retrieve

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

The netex ID or sequence number of the version to retrieve

Get a specific purchase window version › Headers

ET-Client-Name
​string · style: simple

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: <company>-<application>.

X-Correlation-Id
​string · style: simple

Correlation id

Get a specific purchase window version › Responses

The purchase window version

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

Update an existing purchase window version

PUT
https://api.entur.io/products
/v3/parameters/purchase-windows/{id}/{version}

Update a purchase window version in place. Only DRAFT versions can be updated.

Update an existing purchase window version › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The netex ID of the element to retrieve

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

The netex ID or sequence number of the version to retrieve

Update an existing purchase window version › Headers

ET-Client-Name
​string · style: simple

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: <company>-<application>.

X-Correlation-Id
​string · style: simple

Correlation id

Update an existing purchase window version › Request Body

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

Update an existing purchase window version › Responses

Purchase window version updated successfully

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

Delete a purchase window version

DELETE
https://api.entur.io/products
/v3/parameters/purchase-windows/{id}/{version}

Delete a purchase window version. Only DRAFT versions can be deleted.

Delete a purchase window version › path Parameters

id
​string · pattern: ^([A-Z]{3}):([A-Za-z… · required · style: simple

The netex ID of the element to retrieve

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

The netex ID or sequence number of the version to retrieve

Delete a purchase window version › Headers

ET-Client-Name
​string · style: simple

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: <company>-<application>.

X-Correlation-Id
​string · style: simple

Correlation id

Delete a purchase window version › Responses

Purchase window version deleted

No data returned
Version
Did you find what you were looking for?