Schemas

VatGrpupType

string · enum

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

VAT group type. This is used to determine which VAT rate applies to a product. The VAT group type is determined by the product type and the country of sale. For example, in Norway, food products are subject to a reduced VAT rate of 15%, while other products are subject to the standard VAT rate of 25%. In this case, food products would be classified as FOOD_VAT, while other products would be classified as GENERAL_VAT.

Default: TRANSPORT_AND_TICKETS_VAT

VersionStatus

string · enum

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

FareProductRef

Reference to a specific version of a fare product (e.g. SupplementProduct, PreassignedFareProduct).

fareProductId

string · required

NeTEx ID of the fare product.

Example: EXA:SupplementProduct:e006fb5c

fareProductVersionId

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

NeTEx version ID of the fare product.

Example: EXA:Version:FP-4725c71a-abcd-1234-efgh-567890abcdef

fareProductVersionNumber

integer

Sequence number of the fare product version. Optional — set at publication.

Example: 5

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

detail

string · required

Human-readable explanation specific to this occurrence.

Example: The supplied ruleId is not a valid UUID.

status

integer · int32 · required

The HTTP status code.

Example: 400

instance

string · uri

A URI reference that identifies the specific occurrence.

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

PurchaseWindow

id

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

The NeTEx ID of this PurchaseWindow.

Example: ENT:PurchaseWindow:120days

object[] · required

purchaseWhen

string · enum · required

When the product can be purchased relative to departure.

Enum values:

ADVANCE_ONLY

UNTIL_DEPARTURE

AFTER_BOARDING

ANY_TIME

maximumPeriodBeforeDeparture

string · required

Maximum time before departure that a purchase can be made. ISO 8601 duration.

Example: P120D

minimumPeriodBeforeDeparture

string

Minimum time before departure that a purchase can be made. ISO 8601 duration.

Example: PT0S

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

The ID of the organisation that owns the version. The service will fetch the owner organisation from auth token if no organizsation i set here.

AssignmentError

Error details for a failed assignment.

code

string · enum · required

Machine-readable error code.

Enum values:

NO_AGREEMENT

NOT_FOUND

ACCESS_DENIED

VALIDITY_CONFLICT

DRAFT_IN_PROGRESS

Example: NO_AGREEMENT

message

string · required

Human-readable error message.

Example: Ingen avtale med SJN for denne salgspakka

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.

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

changed

string · date-time · required

Changed datetime

created

string · date-time · required

Created datetime

startDate

string · date · required

The start date of the version.

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

ConditionsSummary

refundable

boolean · required

Whether the supplement product is refundable.

Example: false

exchangeable

boolean · required

Whether the supplement product is exchangeable.

Example: true

fareStructureType

FareStructureType · enum · required

The type of fare structure. This indicates the method by which the fare is calculated, e.g. flat fare, zonal fare, point-to-point fare, etc.

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

FareStructureType

string · enum

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

The type of fare structure. This indicates the method by which the fare is calculated, e.g. flat fare, zonal fare, point-to-point fare, etc.

ChargingMomentType

string · enum

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

BEFORE_TRAVEL_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

Charging moment type.

Note: Currently, only BEFORE_TRAVEL is supported in Entur sales platform.

ValidityParameters

groupingType

GenericParameterAssignmentGroupingType · enum · required

How multiple GPA parameters should be combined (AND/OR)

Enum values:

AND

validityParameterRefs

string[] · required

List of references for the validity parameters

validityParameterType

string · enum · required

Enum values:

LINE

ZONE

ZONE_GROUP

STOP_PLACE

PARKING

ROUTE_SECTION

TARIFF_AUTHORITY

OPERATOR

EntitlementRequired

id

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

The NeTEx ID of this EntitlementRequired.

Example: ENT:EntitlementRequired:SingleTicket

object[] · required

fareProductRef

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

Reference to the fare product that satisfies this entitlement.

Example: ENT:PreassignedFareProduct:SingleTrip

entitlementType

string · enum · required

The type of entitlement that is required.

Enum values:

SINGLE_TRIP

PERIOD_PASS

DAY_PASS

CARNET

FareProductListItem

id

string · required

NeTEx ID of the fare product.

Example: EXA:SupplementProduct:e006fb5c

versionId

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

NeTEx version ID of the fare product.

Example: EXA:Version:FP-4725c71a-abcd-1234-efgh-567890abcdef

productType

string · enum · required

Type of the fare product.

Enum values:

SUPPLEMENT_PRODUCT

PREASSIGNED_FARE_PRODUCT

Example: SUPPLEMENT_PRODUCT

object[]

UsageValidityPeriod

id

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

The NeTEx ID of this UsageValidityPeriod.

Example: ENT:UsageValidityPeriod:DuringTravel

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

PurchaseWindowRequest

object[] · required

purchaseWhen

string · enum · required

When the product can be purchased relative to departure.

Enum values:

ADVANCE_ONLY

UNTIL_DEPARTURE

AFTER_BOARDING

ANY_TIME

maximumPeriodBeforeDeparture

string · required

Maximum time before departure that a purchase can be made. ISO 8601 duration.

Example: P120D

minimumPeriodBeforeDeparture

string

Minimum time before departure that a purchase can be made. ISO 8601 duration.

Example: PT0S

SupplementProductType

string · enum

Enum values:

SEAT_RESERVATION

BICYCLE

DOG

ANIMAL

MEAL

WIFI

EXTRA_LUGGAGE

PENALTY

The type of the supplement product. This can be used to determine which parameters are relevant for the product.

SalesOfferPackageRequest

object[] · required

status

string · enum

Status of the created sales package version. Defaults to VERSIONED.

DRAFT - Creates a draft version.
PROPOSED - Creates a proposed version pending review.
VERSIONED - Publishes the version immediately (default).

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

FareProductRef[]

List of fare product references to include in this sales package.

SupplementProductRequest

object[] · required

status

string · enum · required

Status of the supplement product. Defaults to VERSIONED.

DRAFT - Under construction and not ready for operational use.
PROPOSED - Complete but pending review and approval.
VERSIONED - Finalized and frozen; a new version must be created for further modifications. Remains authoritative for its validity period even after expiry.
DEPRECATED - Explicitly withdrawn and should not be used; indicates an active decision to retract, not a natural expiry.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

vatGroup

VatGrpupType · enum · required

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

object · required

startDate

string · date · required

The start date of the version.

ConditionsSummary · required

purchaseWindowRef

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

NeTEx ID of a PurchaseWindow instance (limitations/purchase-window). Available values are listed in the Parameter Catalog API.

Example: ENT:PurchaseWindow:120days

chargingMomentType

ChargingMomentType · enum · required

Charging moment type.

Note: Currently, only BEFORE_TRAVEL is supported in Entur sales platform.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

BEFORE_TRAVEL_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

ValidityParameters[] · required

List of validity parameters. The specified parameter tells where the supplement product is valid. This can be lines, zones, stops etc.

ownerOrganisationId

integer · int64 · required

The ID of the organization that owns the supplement product. Available organizations can be retrieved from the Organization Management API (external to this specification).

supplementProductType

SupplementProductType · enum · required

The type of the supplement product. This can be used to determine which parameters are relevant for the product.

Enum values:

SEAT_RESERVATION

BICYCLE

DOG

ANIMAL

MEAL

WIFI

EXTRA_LUGGAGE

PENALTY

usageValidityPeriodRef

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

NeTEx ID of a UsageValidityPeriod instance (limitations/usage-validity-period). Available values are listed in the Parameter Catalog API.

Example: ENT:UsageValidityPeriod:DuringTravel

entitlementRequiredRefs

string[] · minItems: 1 · required

List of NeTEx IDs of EntitlementRequired instances (limitations/entitlement-required). Available values are listed in the Parameter Catalog API.

endDate

string · date

The end date of the version (optional).

privateCode

string

Optional external system identifier. Used to generate the NeTEx ID as the last segment (e.g., privateCode '123' produces 'XXX:SupplementProduct:123'). If not provided, the NeTEx ID will be generated automatically.

Example: 123

object[]

SalesOfferPackageResponse

id

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

NeTEx ID of the sales package.

Example: VYG:SalesOfferPackage:07c4332c

object[] · required

status

string · enum · required

Status of this sales package version.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

versionId

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

NeTEx version ID.

Example: VYG:Version:SP-905ec954-abcd-1234-efgh-567890abcdef

validTo

string · date

End of the validity period. No specified date means that the validity period has no end-date.

Example: 2026-12-31

validFrom

string · date

Start of the validity period (travel dates, not version date).

Example: 2026-03-18

FareProductRef[]

List of fare product references included in this sales package.

publishedDate

string · date-time

System-assigned timestamp of when the version was published. Only present for VERSIONED status.

Example: 2026-03-18T10:30:00Z

versionNumber

integer

The version number. Only present for published versions.

Example: 14

ownerOrganisationId

integer

The ID of the organization that owns the sales package.

Example: 1

SupplementProductResponse

id

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

The NeTEx ID of the supplement product.

Example: BNR:SupplementProduct:123

object[] · required

status

string · enum · required

Status of the supplement product.

DRAFT - Under construction and not ready for operational use.
PROPOSED - Complete but pending review and approval.
VERSIONED - Finalized and frozen; a new version must be created for further modifications. Remains authoritative for its validity period even after expiry.
DEPRECATED - Explicitly withdrawn and should not be used; indicates an active decision to retract, not a natural expiry.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

vatGroup

VatGrpupType · enum · required

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

object · required

startDate

string · date · required

The start date of the version.

versionId

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

The netex id reference to the object.

Example: EXA:Version:001

ConditionsSummary · required

purchaseWindowRef

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

NeTEx ID of a PurchaseWindow instance (limitations/purchase-window). Available values are listed in the Parameter Catalog API.

Example: ENT:PurchaseWindow:120days

chargingMomentType

ChargingMomentType · enum · required

Charging moment type.

Note: Currently, only BEFORE_TRAVEL is supported in Entur sales platform.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

BEFORE_TRAVEL_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

ValidityParameters[] · required

List of validity parameters. The specified parameter tells where the supplement product is valid. This can be lines, zones, stops etc.

ownerOrganisationId

integer · int64 · required

The ID of the organization that owns the supplement product. Refer to your organization management service or documentation for how to obtain valid organization IDs.

supplementProductType

SupplementProductType · enum · required

The type of the supplement product. This can be used to determine which parameters are relevant for the product.

Enum values:

SEAT_RESERVATION

BICYCLE

DOG

ANIMAL

MEAL

WIFI

EXTRA_LUGGAGE

PENALTY

usageValidityPeriodRef

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

NeTEx ID of a UsageValidityPeriod instance (limitations/usage-validity-period). Available values are listed in the Parameter Catalog API.

Example: ENT:UsageValidityPeriod:DuringTravel

entitlementRequiredRefs

string[] · minItems: 1 · required

List of NeTEx IDs of EntitlementRequired instances (limitations/entitlement-required). Available values are listed in the Parameter Catalog API.

endDate

string · date

The end date of the version (optional).

object

The datasource that owns this supplement product.

privateCode

string

Example: 123

object[]

versionNumber

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

EntitlementRequiredRequest

object[] · required

fareProductRef

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

Reference to the fare product that satisfies this entitlement.

Example: ENT:PreassignedFareProduct:SingleTrip

entitlementType

string · enum · required

The type of entitlement that is required.

Enum values:

SINGLE_TRIP

PERIOD_PASS

DAY_PASS

CARNET

PurchaseWindowListResponse

page

integer · required

Current zero-based page number.

Example: 0

size

integer · required

Number of instances per page.

Example: 100

PurchaseWindow[] · required

totalCount

integer · required

Total number of PurchaseWindow instances.

Example: 5

UsageValidityPeriodRequest

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

EntitlementRequiredListResponse

page

integer · required

Current zero-based page number.

Example: 0

size

integer · required

Number of instances per page.

Example: 100

EntitlementRequired[] · required

totalCount

integer · required

Total number of EntitlementRequired instances.

Example: 4

UsageValidityPeriodListResponse

page

integer · required

Current zero-based page number.

Example: 0

size

integer · required

Number of instances per page.

Example: 100

UsageValidityPeriod[] · required

totalCount

integer · required

Total number of UsageValidityPeriod instances.

Example: 8

SupplementProductVersionListItem

id

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

NeTEx ID of the supplement product.

Example: EXA:SupplementProduct:456

versionId

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

NeTEx version ID.

Example: EXA:Version:SP-abc123-v1

SalesOfferPackageAssignmentRequest

fareProductVersionId

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

NeTEx version ID of the fare product version to assign.

Example: EXA:Version:FP-4725c71a-abcd-1234-efgh-567890abcdef

salesOfferPackageIds

string[] · minItems: 1 · required

List of sales package NeTEx IDs to assign the fare product to.

status

string · enum

Status of the created sales package version. Defaults to VERSIONED (auto-publish).

DRAFT - Creates a draft version that must be manually published via PUT /sales-offer-packages/{id}/publication.
PROPOSED - Creates a proposed version pending review.
VERSIONED - Auto-publishes the new version immediately (default).

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

SalesOfferPackageAssignmentListItem

fareProductId

string · required

NeTEx ID of the fare product.

Example: EXA:SupplementProduct:e006fb5c

salesOfferPackageId

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

NeTEx ID of the sales package.

Example: VYG:SalesOfferPackage:07c4332c

fareProductVersionId

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

NeTEx version ID of the assigned fare product version.

Example: EXA:Version:FP-4725c71a-abcd-1234-efgh-567890abcdef

object[]

SalesOfferPackageAssignmentResponse

SalesOfferPackageAssignmentResultItem[] · required

Per-sales-offer-package result. Best-effort — failure on one sales package does not stop others.

SalesOfferPackagePublicationRequest

status

string · enum · required

Target status. Valid transitions: DRAFT → PROPOSED → VERSIONED, PROPOSED → DRAFT.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

validFrom

string · date · required

Start of the validity period (travel dates).

Example: 2026-03-18

versionId

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

NeTEx version ID of the sales package version to publish.

Example: VYG:Version:SP-905ec954-abcd-1234-efgh-567890abcdef

validTo

string · date

End of the validity period. No specified date means that the validity period has no end-date.

Example: 2026-12-31

SalesOfferPackagePublicationResponse

status

string · enum · required

The resulting version status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

validFrom

string · date · required

Start of the validity period.

Example: 2026-03-18

versionId

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

NeTEx version ID.

Example: VYG:Version:SP-905ec954-abcd-1234-efgh-567890abcdef

salesOfferPackageId

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

NeTEx ID of the sales package.

Example: VYG:SalesOfferPackage:07c4332c

validTo

string · date

End of the validity period. No specified date means that the validity period has no end-date.

Example: 2026-12-31

publishedDate

string · date-time

System-assigned publication timestamp. Only present for VERSIONED status.

Example: 2026-03-18T10:30:00Z

versionNumber

integer

Version number assigned at publication. Only present for VERSIONED status.

Example: 14

SalesOfferPackageAssignmentResultItem

status

string · enum · required

Whether the assignment succeeded or failed for this sales package.

Enum values:

SUCCESS

FAILED

Example: SUCCESS

salesOfferPackageId

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

NeTEx ID of the sales package.

Example: VYG:SalesOfferPackage:07c4332c

AssignmentError

Error details for a failed assignment.

versionNumber

integer

Version number of the created version. Only present when versionStatus is VERSIONED.

Example: 14

versionStatus

string · enum

The status of the created sales package version. Only present on success.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

createdVersionId

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

NeTEx version ID of the newly created sales package version. Only present on success.

Example: VYG:Version:SP-905ec954-abcd-1234-efgh-567890abcdef

GenericParameterAssignmentGroupingType

string · enum

Enum values:

AND

How multiple GPA parameters should be combined (AND/OR)

Products (Draft)

Schemas

Download schema

VatGrpupType

string · enum

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

VersionStatus

string · enum

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

FareProductRef

Reference to a specific version of a fare product (e.g. SupplementProduct, PreassignedFareProduct).

fareProductId

string · required

NeTEx ID of the fare product.

Example: EXA:SupplementProduct:e006fb5c

fareProductVersionId

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

NeTEx version ID of the fare product.

Example: EXA:Version:FP-4725c71a-abcd-1234-efgh-567890abcdef

fareProductVersionNumber

integer

Sequence number of the fare product version. Optional — set at publication.

Example: 5

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

detail

string · required

Human-readable explanation specific to this occurrence.

Example: The supplied ruleId is not a valid UUID.

status

integer · int32 · required

The HTTP status code.

Example: 400

instance

string · uri

A URI reference that identifies the specific occurrence.

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

PurchaseWindow

id

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

The NeTEx ID of this PurchaseWindow.

Example: ENT:PurchaseWindow:120days

object[] · required

purchaseWhen

string · enum · required

When the product can be purchased relative to departure.

Enum values:

ADVANCE_ONLY

UNTIL_DEPARTURE

AFTER_BOARDING

ANY_TIME

maximumPeriodBeforeDeparture

string · required

Maximum time before departure that a purchase can be made. ISO 8601 duration.

Example: P120D

minimumPeriodBeforeDeparture

string

Minimum time before departure that a purchase can be made. ISO 8601 duration.

Example: PT0S

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

The ID of the organisation that owns the version. The service will fetch the owner organisation from auth token if no organizsation i set here.

AssignmentError

Error details for a failed assignment.

code

string · enum · required

Machine-readable error code.

Enum values:

NO_AGREEMENT

NOT_FOUND

ACCESS_DENIED

VALIDITY_CONFLICT

DRAFT_IN_PROGRESS

Example: NO_AGREEMENT

message

string · required

Human-readable error message.

Example: Ingen avtale med SJN for denne salgspakka

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.

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

changed

string · date-time · required

Changed datetime

created

string · date-time · required

Created datetime

startDate

string · date · required

The start date of the version.

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

ConditionsSummary

refundable

boolean · required

Whether the supplement product is refundable.

Example: false

exchangeable

boolean · required

Whether the supplement product is exchangeable.

Example: true

fareStructureType

FareStructureType · enum · required

The type of fare structure. This indicates the method by which the fare is calculated, e.g. flat fare, zonal fare, point-to-point fare, etc.

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

FareStructureType

string · enum

Enum values:

CAPPED_FLAT_FARE

CAPPED_POINT_TO_POINT_FARE

CAPPED_ZONAL_FARE

LINE_FLAT_FARE

NETWORK_FLAT_FARE

POINT_TO_POINT_FARE

POINT_TO_POINT_DISTANCE_FARE

STAGE_FARE

The type of fare structure. This indicates the method by which the fare is calculated, e.g. flat fare, zonal fare, point-to-point fare, etc.

ChargingMomentType

string · enum

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

BEFORE_TRAVEL_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

Charging moment type.

Note: Currently, only BEFORE_TRAVEL is supported in Entur sales platform.

ValidityParameters

groupingType

GenericParameterAssignmentGroupingType · enum · required

How multiple GPA parameters should be combined (AND/OR)

Enum values:

AND

validityParameterRefs

string[] · required

List of references for the validity parameters

validityParameterType

string · enum · required

Enum values:

LINE

ZONE

ZONE_GROUP

STOP_PLACE

PARKING

ROUTE_SECTION

TARIFF_AUTHORITY

OPERATOR

EntitlementRequired

id

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

The NeTEx ID of this EntitlementRequired.

Example: ENT:EntitlementRequired:SingleTicket

object[] · required

fareProductRef

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

Reference to the fare product that satisfies this entitlement.

Example: ENT:PreassignedFareProduct:SingleTrip

entitlementType

string · enum · required

The type of entitlement that is required.

Enum values:

SINGLE_TRIP

PERIOD_PASS

DAY_PASS

CARNET

FareProductListItem

id

string · required

NeTEx ID of the fare product.

Example: EXA:SupplementProduct:e006fb5c

versionId

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

NeTEx version ID of the fare product.

Example: EXA:Version:FP-4725c71a-abcd-1234-efgh-567890abcdef

productType

string · enum · required

Type of the fare product.

Enum values:

SUPPLEMENT_PRODUCT

PREASSIGNED_FARE_PRODUCT

Example: SUPPLEMENT_PRODUCT

object[]

UsageValidityPeriod

id

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

The NeTEx ID of this UsageValidityPeriod.

Example: ENT:UsageValidityPeriod:DuringTravel

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

PurchaseWindowRequest

object[] · required

purchaseWhen

string · enum · required

When the product can be purchased relative to departure.

Enum values:

ADVANCE_ONLY

UNTIL_DEPARTURE

AFTER_BOARDING

ANY_TIME

maximumPeriodBeforeDeparture

string · required

Maximum time before departure that a purchase can be made. ISO 8601 duration.

Example: P120D

minimumPeriodBeforeDeparture

string

Minimum time before departure that a purchase can be made. ISO 8601 duration.

Example: PT0S

SupplementProductType

string · enum

Enum values:

SEAT_RESERVATION

BICYCLE

DOG

ANIMAL

MEAL

WIFI

EXTRA_LUGGAGE

PENALTY

The type of the supplement product. This can be used to determine which parameters are relevant for the product.

SalesOfferPackageRequest

object[] · required

status

string · enum

Status of the created sales package version. Defaults to VERSIONED.

DRAFT - Creates a draft version.
PROPOSED - Creates a proposed version pending review.
VERSIONED - Publishes the version immediately (default).

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

FareProductRef[]

List of fare product references to include in this sales package.

SupplementProductRequest

object[] · required

status

string · enum · required

Status of the supplement product. Defaults to VERSIONED.

DRAFT - Under construction and not ready for operational use.
PROPOSED - Complete but pending review and approval.
VERSIONED - Finalized and frozen; a new version must be created for further modifications. Remains authoritative for its validity period even after expiry.
DEPRECATED - Explicitly withdrawn and should not be used; indicates an active decision to retract, not a natural expiry.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

vatGroup

VatGrpupType · enum · required

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

object · required

startDate

string · date · required

The start date of the version.

ConditionsSummary · required

purchaseWindowRef

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

NeTEx ID of a PurchaseWindow instance (limitations/purchase-window). Available values are listed in the Parameter Catalog API.

Example: ENT:PurchaseWindow:120days

chargingMomentType

ChargingMomentType · enum · required

Charging moment type.

Note: Currently, only BEFORE_TRAVEL is supported in Entur sales platform.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

BEFORE_TRAVEL_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

ValidityParameters[] · required

List of validity parameters. The specified parameter tells where the supplement product is valid. This can be lines, zones, stops etc.

ownerOrganisationId

integer · int64 · required

The ID of the organization that owns the supplement product. Available organizations can be retrieved from the Organization Management API (external to this specification).

supplementProductType

SupplementProductType · enum · required

The type of the supplement product. This can be used to determine which parameters are relevant for the product.

Enum values:

SEAT_RESERVATION

BICYCLE

DOG

ANIMAL

MEAL

WIFI

EXTRA_LUGGAGE

PENALTY

usageValidityPeriodRef

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

NeTEx ID of a UsageValidityPeriod instance (limitations/usage-validity-period). Available values are listed in the Parameter Catalog API.

Example: ENT:UsageValidityPeriod:DuringTravel

entitlementRequiredRefs

string[] · minItems: 1 · required

List of NeTEx IDs of EntitlementRequired instances (limitations/entitlement-required). Available values are listed in the Parameter Catalog API.

endDate

string · date

The end date of the version (optional).

privateCode

string

Example: 123

object[]

SalesOfferPackageResponse

id

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

NeTEx ID of the sales package.

Example: VYG:SalesOfferPackage:07c4332c

object[] · required

status

string · enum · required

Status of this sales package version.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

versionId

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

NeTEx version ID.

Example: VYG:Version:SP-905ec954-abcd-1234-efgh-567890abcdef

validTo

string · date

End of the validity period. No specified date means that the validity period has no end-date.

Example: 2026-12-31

validFrom

string · date

Start of the validity period (travel dates, not version date).

Example: 2026-03-18

FareProductRef[]

List of fare product references included in this sales package.

publishedDate

string · date-time

System-assigned timestamp of when the version was published. Only present for VERSIONED status.

Example: 2026-03-18T10:30:00Z

versionNumber

integer

The version number. Only present for published versions.

Example: 14

ownerOrganisationId

integer

The ID of the organization that owns the sales package.

Example: 1

SupplementProductResponse

id

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

The NeTEx ID of the supplement product.

Example: BNR:SupplementProduct:123

object[] · required

status

string · enum · required

Status of the supplement product.

DRAFT - Under construction and not ready for operational use.
PROPOSED - Complete but pending review and approval.
VERSIONED - Finalized and frozen; a new version must be created for further modifications. Remains authoritative for its validity period even after expiry.
DEPRECATED - Explicitly withdrawn and should not be used; indicates an active decision to retract, not a natural expiry.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

vatGroup

VatGrpupType · enum · required

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Default: TRANSPORT_AND_TICKETS_VAT

object · required

startDate

string · date · required

The start date of the version.

versionId

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

The netex id reference to the object.

Example: EXA:Version:001

ConditionsSummary · required

purchaseWindowRef

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

NeTEx ID of a PurchaseWindow instance (limitations/purchase-window). Available values are listed in the Parameter Catalog API.

Example: ENT:PurchaseWindow:120days

chargingMomentType

ChargingMomentType · enum · required

Charging moment type.

Note: Currently, only BEFORE_TRAVEL is supported in Entur sales platform.

Enum values:

BEFORE_TRAVEL

ON_START_OF_TRAVEL

BEFORE_END_OF_TRAVEL

BEFORE_TRAVEL_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_TRAVEL

ON_START_THEN_ADJUST_AT_END_OF_FARE_DAY

ON_START_THEN_ADJUST_AT_END_OF_CHARGE_PERIOD

AT_END_OF_TRAVEL

ValidityParameters[] · required

List of validity parameters. The specified parameter tells where the supplement product is valid. This can be lines, zones, stops etc.

ownerOrganisationId

integer · int64 · required

The ID of the organization that owns the supplement product. Refer to your organization management service or documentation for how to obtain valid organization IDs.

supplementProductType

SupplementProductType · enum · required

The type of the supplement product. This can be used to determine which parameters are relevant for the product.

Enum values:

SEAT_RESERVATION

BICYCLE

DOG

ANIMAL

MEAL

WIFI

EXTRA_LUGGAGE

PENALTY

usageValidityPeriodRef

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

NeTEx ID of a UsageValidityPeriod instance (limitations/usage-validity-period). Available values are listed in the Parameter Catalog API.

Example: ENT:UsageValidityPeriod:DuringTravel

entitlementRequiredRefs

string[] · minItems: 1 · required

List of NeTEx IDs of EntitlementRequired instances (limitations/entitlement-required). Available values are listed in the Parameter Catalog API.

endDate

string · date

The end date of the version (optional).

object

The datasource that owns this supplement product.

privateCode

string

Example: 123

object[]

versionNumber

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

EntitlementRequiredRequest

object[] · required

fareProductRef

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

Reference to the fare product that satisfies this entitlement.

Example: ENT:PreassignedFareProduct:SingleTrip

entitlementType

string · enum · required

The type of entitlement that is required.

Enum values:

SINGLE_TRIP

PERIOD_PASS

DAY_PASS

CARNET

PurchaseWindowListResponse

page

integer · required

Current zero-based page number.

Example: 0

size

integer · required

Number of instances per page.

Example: 100

PurchaseWindow[] · required

totalCount

integer · required

Total number of PurchaseWindow instances.

Example: 5

UsageValidityPeriodRequest

object[] · required

usageValidityType

string · enum · required

The type of usage validity.

Enum values:

SINGLE_TRIP

RETURN_TRIP

CARNET

DAY_PASS

WEEKLY_PASS

MONTHLY_PASS

ANNUAL_PASS

CUSTOM_PERIOD

activationType

string · enum

What triggers the start of the validity period.

Enum values:

ON_PURCHASE

ON_FIRST_USE

ON_CHECK_IN

validityPeriod

string

How long the product is valid after activation. ISO 8601 duration.

Example: PT60M

EntitlementRequiredListResponse

page

integer · required

Current zero-based page number.

Example: 0

size

integer · required

Number of instances per page.

Example: 100

EntitlementRequired[] · required

totalCount

integer · required

Total number of EntitlementRequired instances.

Example: 4

UsageValidityPeriodListResponse

page

integer · required

Current zero-based page number.

Example: 0

size

integer · required

Number of instances per page.

Example: 100

UsageValidityPeriod[] · required

totalCount

integer · required

Total number of UsageValidityPeriod instances.

Example: 8

SupplementProductVersionListItem

id

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

NeTEx ID of the supplement product.

Example: EXA:SupplementProduct:456

versionId

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

NeTEx version ID.

Example: EXA:Version:SP-abc123-v1

SalesOfferPackageAssignmentRequest

fareProductVersionId

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

NeTEx version ID of the fare product version to assign.

Example: EXA:Version:FP-4725c71a-abcd-1234-efgh-567890abcdef

salesOfferPackageIds

string[] · minItems: 1 · required

List of sales package NeTEx IDs to assign the fare product to.

status

string · enum

Status of the created sales package version. Defaults to VERSIONED (auto-publish).

DRAFT - Creates a draft version that must be manually published via PUT /sales-offer-packages/{id}/publication.
PROPOSED - Creates a proposed version pending review.
VERSIONED - Auto-publishes the new version immediately (default).

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

SalesOfferPackageAssignmentListItem

fareProductId

string · required

NeTEx ID of the fare product.

Example: EXA:SupplementProduct:e006fb5c

salesOfferPackageId

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

NeTEx ID of the sales package.

Example: VYG:SalesOfferPackage:07c4332c

fareProductVersionId

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

NeTEx version ID of the assigned fare product version.

Example: EXA:Version:FP-4725c71a-abcd-1234-efgh-567890abcdef

object[]

SalesOfferPackageAssignmentResponse

SalesOfferPackageAssignmentResultItem[] · required

Per-sales-offer-package result. Best-effort — failure on one sales package does not stop others.

SalesOfferPackagePublicationRequest

status

string · enum · required

Target status. Valid transitions: DRAFT → PROPOSED → VERSIONED, PROPOSED → DRAFT.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

validFrom

string · date · required

Start of the validity period (travel dates).

Example: 2026-03-18

versionId

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

NeTEx version ID of the sales package version to publish.

Example: VYG:Version:SP-905ec954-abcd-1234-efgh-567890abcdef

validTo

string · date

End of the validity period. No specified date means that the validity period has no end-date.

Example: 2026-12-31

SalesOfferPackagePublicationResponse

status

string · enum · required

The resulting version status.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

validFrom

string · date · required

Start of the validity period.

Example: 2026-03-18

versionId

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

NeTEx version ID.

Example: VYG:Version:SP-905ec954-abcd-1234-efgh-567890abcdef

salesOfferPackageId

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

NeTEx ID of the sales package.

Example: VYG:SalesOfferPackage:07c4332c

validTo

string · date

End of the validity period. No specified date means that the validity period has no end-date.

Example: 2026-12-31

publishedDate

string · date-time

System-assigned publication timestamp. Only present for VERSIONED status.

Example: 2026-03-18T10:30:00Z

versionNumber

integer

Version number assigned at publication. Only present for VERSIONED status.

Example: 14

SalesOfferPackageAssignmentResultItem

status

string · enum · required

Whether the assignment succeeded or failed for this sales package.

Enum values:

SUCCESS

FAILED

Example: SUCCESS

salesOfferPackageId

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

NeTEx ID of the sales package.

Example: VYG:SalesOfferPackage:07c4332c

AssignmentError

Error details for a failed assignment.

versionNumber

integer

Version number of the created version. Only present when versionStatus is VERSIONED.

Example: 14

versionStatus

string · enum

The status of the created sales package version. Only present on success.

Enum values:

DRAFT

PROPOSED

VERSIONED

DEPRECATED

Example: VERSIONED

createdVersionId

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

NeTEx version ID of the newly created sales package version. Only present on success.

Example: VYG:Version:SP-905ec954-abcd-1234-efgh-567890abcdef

GenericParameterAssignmentGroupingType

string · enum

Enum values:

AND

How multiple GPA parameters should be combined (AND/OR)