Changelog

The field groupOfTariffZones in ZonalValidity is now deprecated, replaced by namedGroupOfTariffZones.

Added optional field paused to ProgramAccrualSummary in OfferSummary.eligibleForAccrualInPrograms. Value true if point accrual is currently paused, despite the offer normally earning the customer points in the program

Added optional fields validityParameterSetSelectionType to SpecificParameterAssignment (SPA) and groupOfTariffZonesRef to the underlying ValidityParameters

Added optional DateTime parameter to TripPatternSearchRequest, allowing for more precise searches if a ServiceJourney passes the same stop twice on a trip

Types GeoIntervalData, ZonalValidity, PlaceInJourneySpec, ValidityParameter and DynamicDistanceMatrixElement have added new fields supporting FareZones (fareZones, fareZoneRef etc).

Response types GeoIntervalData, ZonalValidity, PlaceInJourneySpec, ValidityParameter and DynamicDistanceMatrixElement, all fields referring to tariffZone fields have all been deprecated (zones, tariffZoneRef etc). Clients using /offers/v2/search/zones or the option for existingTicket for any endpoint should upgrade to ask with FareZoneIds.

New field ticketType on SearchWithServiceJourney (/offers/v2/offline-cache/service-journey/stops). Allows clients to search for period passes or single tickets for offline sales.

New field availablePrograms on OfferSummary. Indicates that the customer can join a personalisation program to gain points from buying the offer.

New header EXPIRES added to /search endpoint response. After that time, the offer can no longer be purchased and the client must create a new offer.

The headers Skip-Offers-Caching and ResponseType are deprecated for all search endpoints.

The search endpoints will now always return offer summaries.

Dedicated new search endpoints for creating detailed offers are made available to internal clients. These endpoints cannot be used to create online sellable offers, and are intended for offline caching.

The offer explain fields salesPackageIds and fareProductIds are deprecated (new field for all types added)

The fields userProfiles, pricingBasis, minNumberOfPersons and maxNumberOfPersons in PricedGroup are deprecated

The field optional in PricedGroup is deprecated

The v2 swagger spec is now available at https://api.entur.io/api-docs/offers

The v1 and v2 beta of the API is now deprecated, and all consumers should start migrating to the v2 API. End of life date for Offers v1 and v2 beta has been set to October 1, 2023.

• Added endpoint POST /offers/v2/search/authority.

• HTTP status code change in endpoints search/stop-places, search/zones and search/trip-pattern. This rectifies some cases where a 404 situation was reported as 500.

• Added endpoint GET /offers/v2/journey-spec/{id}.

• Offers v2 endpoints will now return v2 Offer instead of v1 Offer when header ResponseType=SearchResponseFull is received. Also, the triggering header value is changed from SearchResponseFullV1 to SearchResponseFull.

• Filtering of returned offers in endpoint /search/stop-places now allows sales packages with multiple authorities if no other alternative exists for the same uvpType and journey. As a consequence, the number of returned offers may increase.

• V2 endpoint /search/rail-stations renamed to /search/stop-places.

• V2 API available for test.

• Will now filter out some offers with zero price.

Ability to switch between Products and ProductConfiguration services for trip search requests

Added possibility to specify number of wanted compartments, this makes use of a non-greedy algorithm when assigning travellers to a sleeping compartment.

New endpoints for offers search by zones. Both for extension tickets and ordinary offers.

Reuse of authority configuration. Should cause less overhead for requests that include authorization