Assign the supplement products to sales packages without knowledge of the full sales package structure.
List sales package assignments for a supplement product
List all sales packages that a supplement product is currently assigned to, including the version reference for each assignment.
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe netex ID of the element to retrieve
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
List sales package assignments for a supplement product › Responses
List of sales package assignments
fareProductIdNeTEx ID of the fare product.
salesOfferPackageId^([A-Z]{3}):SalesOff… · requiredNeTEx ID of the sales package.
fareProductVersionId^([A-Z]{3}):Version:… · requiredNeTEx version ID of the assigned fare product version.
Assign supplement product to sales packages
Assign a supplement product to one or more sales packages. Each assignment creates a new version of the target sales package containing the supplement product reference.
This is a best-effort batch operation — failure on one sales package does not prevent processing of the others. The response body conveys per-item results; callers must inspect each item's status rather than relying solely on the HTTP status code.
If the supplement product is already assigned to a sales package but with a different version, the version reference is updated (upsert semantics).
The caller must have an agreement with the sales package owner (verified against the agreement register). The caller must also own the supplement product.
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe netex ID of the element to retrieve
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Assign supplement product to sales packages › Request Body
fareProductVersionId^([A-Z]{3}):Version:… · requiredNeTEx version ID of the fare product version to assign.
salesOfferPackageIdsList of sales package NeTEx IDs to assign the fare product to.
statusStatus 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).
Assign supplement product to sales packages › Responses
Per-sales-offer-package results. Each item indicates SUCCESS or FAILED with details; inspect individual results rather than relying solely on the HTTP status.
Per-sales-offer-package result. Best-effort — failure on one sales package does not stop others.
Remove supplement product from a sales package
Remove the assignment of a supplement product from a sales package. This creates a new version of the sales package without the supplement product reference.
Only the supplement product owner or the sales package owner can remove the assignment.
path Parameters
id^([A-Z]{3}):([A-Za-z… · required · style: simpleThe netex ID of the element to retrieve
salesOfferPackageId^([A-Z]{3}):SalesOff… · required · style: simpleNeTEx ID of the sales package to remove the assignment from.
Headers
ET-Client-NameEntur 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> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Remove supplement product from a sales package › Responses
Assignment removed successfully