Changelog Sales

• Added flag distributedAsPdf under distribution details on ticket distribution in order for clients to see if this ticket has been generated and sent as PDF-ticket from the ticket-distribution service.

• Added new endpoint to update start of validity `POST /v1/ticket-distribution-groups/update-validities`.

• Added new endpoint to transfer travel rights to another customer `POST /v1/ticket-distribution-groups/transfer-distribution-holder`.

• Added seatingProperties on seat reservations on ticket distribution.
• This object mirrors the properties from seating manager and delivers more flexible ways of displaying different properties on a seat reservation.
• At the same time, seatType and seatCode are deprecated.

• Added leg data on ticket distribution which is based on order data.
• This new leg object can be useful to show the customer the journey has a stop in between
• Whereas the data in topology only says something about where the ticket is valid

• Added fare zones to topology on ticket distributions. Fare zones will eventually replace tariff zones.
• Tariff zones in topology. Use fare zones instead.

• Added ability to search ticket distributions with IN operator.

• Added search for ticket distributions by startOfValidity and endOfValidity.

Breaking:

• The type Reference has changed name to OrderReference
• The type of the field feeRef on DryRunRefundFee has changed from Reference/OrderReference to ProductsElementWrapper

• Endpoint `PUT /v1/orders/{orderId}/orderlines/{orderLineId}` is deprecated. Please use `PUT /v1/orders/{orderId}/orderlines`

• New endpoint for opdating multiple order lines on an order. Using this endpoint is the preferred method to update order lines on an order.
• New event optional field "id" the OrderLineRequest API model.

Breaking:

• Introducing version 1 of the api. The old /v1beta/ will continue to live, but upgrading is advised.
• Introduce a required request-body for refund. This will allow for providing additional data gathered from external devices; i.e terminals.
• Refund operations, as well as the refund rule in an operation, are now required when performing a refund.
• In RefundAdminRequest, refundEntries has become refundOperations.

Deprecated:

• /v1beta/*

Feature:

• New field in RefundAdminRequest for providing data when performing an terminal refund

• Header `Entur-Distribution-Channel` is required for all non search endpoints.

• Header `Entur-Distribution-Channel` is required for all endpoints.

• Endpoint `POST /v1/orders/{orderId}/orderlines/{orderLineId}/cancel` is deprecated. Please use `POST /v1/orders/{orderId}/orderlines/cancel?orderLineIds={orderLineId}`
• Endpoint `DELETE /v1/orders/{orderId}/orderlines/{orderLineId}` is deprecated. Please use `DELETE /v1/orders/{orderId}/orderlines?orderLineIds={orderLineId}`

• New endpoint for cancelling multiple order lines from an order. Using this endpoint is the preferred method to cancel order lines from an order.
• New event type OrderLinesCancelled for collection type events.

• New endpoint for deleting multiple order lines from an order. Using this endpoint is the preferred method to remove order lines from an order.
• New event for collection type events. Currently supported are OrderLinesAdded and OrderLinesRemoved. These events are available on topic `order-event-collections-{env}`.

• Endpoint `/v1/ticket-distributions/{orderId}/distribute` and `/v1/ticket-distributions/{orderId}/distribute-travel-card` is deprecated. Please use `/v1/ticket-distributions-groups/{orderId}/distribute`

• Endpoint `/v1/pdf-tickets/{orderId}/generate` is deprecated. Please use `/v1/ticket-distributions/{orderId}/generate`

• Meta information on all events. Old meta field is deprecated.

• Header `Entur-Distribution-Channel` is required for endpoints `/v1/reserve-offers`, `/v1/update-order` and `/v1/update-order/supplement-products`.

• New query parameter added to /v1beta/refunds/options/{orderId}. If orderVersion is set, calculation will be performed on a CONFIRMED Order of that version. Specifying a version with an Order in DRAFT is not supported.

• /reserve-offers now supports requests without orderId, an order will now be created automatically if orderId is not specified.

• Fully compatible OAS 3 schema now available at /api-docs/order. The old doc is no longer available. Changes are only required for clients who wants to generate code from the new spec.

• Field deprecations on the reserve-offers request: OfferConfiguration.customerIds, OfferConfiguration.entitlements. They were replaced by the field OfferConfiguration.customers in March 2020.
• Field deprecations on the reserve-offers request: OfferConfiguration.count. Please use either selectedTravellerIds or multiple offer configurations, depending on your use case.
• Field removals on the reserve-offers request: OfferConfiguration.reservations. This field was deprecated in May 2019 and has been ignored since March 2020.

• Added new field to reserve-offers request: OfferConfiguration.selectedTravellerIds.
• selectedTravellerIds is used to specify which travellers will be included in the use of this offer. As of 24.08.21, it is only used in connection with the rest compartment and sleeping compartment, but may have several uses later. A validation will be made against the legal number of UserProfiles per compartment.

• New endpoint to add supplement products to order lines. Only supplement products that does not modify seating are supported.
• https://{host}/sales/v1/update-order/supplement-products.

• Changed how SOFT_DECLINE is delivered to the client. Instead of using a Map of strings call errorDetails, it is now an errorReason. Per now, the only errorCode available is SOFT_DECLINE, but it is possible to add other errorReasons when needed.

• Support for Soft Declines for transactions that initially did not need 3d-secure. When a capture-call receives a soft decline response, the client making the capture-call will have to redirect the customer to the terminal from the createTerminal-call. From the terminal, the customer will be prompted to perform a 3D-secure process (or something similar). Soft declines results in http status 409 with the field errorDetails in the PaymentError/response body populated with ConflictReason set to SOFT_DECLINE.

• Fully compatible OAS 3 schema now available at /api-docs/payment. The old doc is no longer available. Changes are only required for clients who wants to generate code from the new spec.

• Fully compatible OAS 3 schema now available at /api-docs/refund. The old doc is no longer available. Changes are required for clients who wants to generate code from the new spec.
• Property RefundResponse.getAffectedPaymentAndPaymentTransactionIds has a type change. Map key is now a string.

• Convert api spec to open api spec version 3. New spec is available at `/api-docs/seating-arrangements`

• New fields added for several Order Events. All changes are fully compatible, and does not affect existing clients
• FeeRemoved: orderVersion
• OrderContactInformationUpdated: orderVersion
• OrderCreated: orderVersion
• OrderExpiredAtSet: orderVersion, timestamp
• OrderExternalReferenceUpdated: orderVersion
• OrderImported: orderVersion
• OrderLineAdded: orderVersion, orderLineVersion
• OrderLineCancelled: orderVersion, orderLineVersion
• OrderLineRemoved: orderVersion, orderLineVersion
• OrderLineUpdated: orderVersion, orderLineVersion
• OrderReset: orderVersion
• ReservationAdded: orderVersion
• ReservationRemoved: orderVersion
• ReservationUpdated: orderVersion
• SpecialOrderCauseAddedOrUpdated: orderVersion
• SpecialOrderCauseRemoved: orderVersion
• TravellerAdded: orderVersion
• TravellerRemoved: orderVersion
• TravellerUpdated: orderVersion

• New endpoint to change order lines in an order.
• https://{host}/sales/v1/update-order.

• Providing order line ids in api-call reserve-offers has been deprecated.
• Please use new endpoint /v1/update-order when changing order lines.

• Do not crash when an order has more than one payment

• New non-required header on refund endpoints: Entur-Settlement-Id
• Validation of value in new header Entur-Settlement-Id if value is present

• Changes to Swagger schema to make it compatible with Openapi 3. Both schema types now available for download from developer portal.

• Added customerIdentificationNumber and externalInvoiceNumber, which are required fields when creating a penalty fare invoice.

• Added Properties from Offer to Order

• DCI-based refunding-possibilities
• Return error message when required headers are missing />

• New type AffectedPaymentTransaction
• New Exceptions: ZeroAllowedPaymentTypeGroupsForDCI, ZeroAllowedTransactionsException
• Determine possible refundable payment transactions based on possible/allowed payment methods for provided DCI. DCI header is now required
• Determine which refund options that can be performed together, if transactionsSum != collectedRefundAmountSum

• Use of new price-lib project for all tax and price calculation

• Only validate / require entitlements for discount offers
• Update k8s apiVersion

• Bugfix for change receipt and order without reservation

• Fixed incorrect display of VAT calculation for rejection using alternative scheduled transport

• Stronger validation of Entitlement against benefits (fraud prevention)

• PersonalTicketInfo for NOD for QR code tickets
• Entitlement information on PDF tickets
• Extension of entitlement information in models
• New endpoint for creating and returning PDF tickets without sending by mail

• Convert new discount to old discount in Cersei
• Support VatRegisters validity date
• External reference when booking offers

• Personnel ticket info on PDF ticket
• Extended entitlement with contract ID

• Convert new discount to old discount in Cersei

• Switch KAFKA_BROKER and KAFKA_SCHEMA_REGISTRY uri
• Ticket with seat ticket info
• Extended deployment tools timeout

• Support for date-based vat registry entries
• Deployed deployment tools its timeout
• GDPR contact information update

• Error retrieving country names from StopPlace
• Removing Travelers from Site Reservation Requests
• Change endpoint to retrieve reservations for reports (now fetching based on ODSJ ID instead of Res. ID)
• Reserve offers with multiple entitlements for the same customer and multiple customers with entitlements

• Support for date-based vat registry entries
• Deployed deployment tools its timeout
• Better dev doc

• Discount Products in STS
• Support for multiple entitlements per traveler on the same order line

• Personal ticket info is linked to ticket distribution and sent to NORD

• Refund ThroughFare SalesPackages without refundingPossibilities on SalesPackage-level.

• Logo and PDF config for SJ Nord

• Ticket change when changing seats

• Upped the timeoutvalue on Vippsconnections and made a small config-change to the swagger-doc regarding how HATEOAS-Links are to be deserialized

• Joint ticket with three legs. Ticket with SJ -> NSB -> SJ generated only two tickets, now three are generated.

• Confirmation of change is now sent out with a new version of order that does not involve payments or credits. (Change of travel date, reservation or contact person)

• Simplified pairing of line items and seats

• Better receipt for alternative scheduled transport
• Confirmation of change is now sent out with a new version of order that does not involve payments or credits. (Change of travel date, reservation or contact person)

• Improved error decoder against victims so that the correct victim ID becomes available in log and response
• Increased timeout towards products so caching at restart should go faster

• Fixed that the undo period became active again when changing the order
• Introduced retrys to retrieve a ticket validity time

• Bugfix: Cancellation of payment types with a fee removed the fee before the payment was canceled
• Bugfix: Some calls against customers logged customer data

• Possibility to search multiple fields from Ops-Center
• PaymentMethods is now linked to the Entur-Distribution-Channel header, and will never be able to retrieve from unless the header

• Reserve-offers attaches new order lines to customers if customerIds is included in the request
• Entitlement is validated against benefits if contract and customer are included in the request
• A customers entitlements are linked to the order line and order line traveler based on contract and customer in the request
• ServiceJourneyPrivateCode and lineId from play in the offer are now included in the order structure

• PurchasedTraveller has now been given contractId and externalEntitlementRef fields
• PurchasedLeg now has info on lineId and serviceJourneyPrivateCode
• Fee has got new optional orderVersion field

• Travelers are assigned to order lines based on customer IDs in the reserve offer request
• Travelers on order lines receive contractId and externalEntitlementRef based on the reserve offer request
• Contract consumption is validated against entitlements

• PurchasedTraveller has now received fields for contractId and externalEntitlementRef

• Distribution Channel ID header is now required to retrieve PaymentMethods. Note that the payment method (s) returned in the response MUST contain the SAME ID as the one used in the header.

• API extensions to use personal ticket and link order lines created from offers with customers

• Traveler validation when removing from order, updating and creating line items, and order import (traveler must be on order if order line should be associated with traveler)

• The service no longer sends old correlationId to other services when it cannot find one

• It says "NSB Comfort" on the Plus tickets
• Use tariff code lookup with new list of connections / supplementProducts

• Missing user profiles for group products

• Upgraded Cassandra driver from version 3 to 4, so we can get away from Java

• Using the right topology type on tickets
• Main changes (for new tickets):
  • Area code for Opplandstrafikk is set when purchasing "enough" zones (defined in products)
  • zoneType (RING / POINT_TO_POINT) is now located on Topology for zone products
  • fullAreaValidity is now located on TicketDistribution and is true if you have access to travel throughout the area (e.g. all Routes zones)

• Greater refactoring of the reservation part of the service

• Fixes around using carrier-specific from-address when sending pdf tickets
• Ability to distribute change ticket

• Subsum is shown on orders that have more than one payment method. (Mainly intended for gift card use, but there is nothing to stop, for example, sharing an order between Vipps and Visa on our part - although we believe this is not possible in clients today.)

• Rules that specify no refund should not provide RefundOptions

• Filtering canceled seats for ticket allocation
• Use of carrier-specific email address sender domains (edited)

• HOTFIX: Added FULLRATE manually in products specc its DiscountBasis

• Fix for deserialization trouble of 404 responses from ticket distribution

• Bugfix for direct booking of seats at OrderLineCancelled

• Fix for cases where fees and "other" get minus sign - this also had unfortunate consequences for showing VAT bill
• Change to domains: en-tur.no -> entur.no: cake:
• Change to CSS that prevents line breaks in the middle of the VAT field heading

• Add support for ResellWhen = AFTER_PURCHASE
• Make new logic surrounding Country selection from country code, which specifically binds the null value to BORDER_CROSSING

• Fix for dci caching
• Fix for duration deserialization from ticket distribution
• Double Reservation Fix for identical line items
• Fix for VAT calculation of price contribution on usage parameter

• Changed Duration from Double to String due to Spring Boot upgrade failure

• Tax code on luggageAllowance

• Remove Entur as sender from SMSes sent from other operators
• The content of change messages sent as SMS is now more appropriate

• PaymentEvents disappear if connection to Cassandra fails
• Validation of order lines

• Support for border crossings in VAT codes (blank VAT code)

• Gift voucher codes on receipt
• Information on receipt for period tickets is missing in the subject field

• The "fee" list on the change receipt is now called "Other" to avoid non-fees being called fees.

• QR code checksum type is now set based on diff between deliverAfter and startOfValidity at new endpoint

• Support for customer card discounts on order lines

• View changes / changed line items on refund receipt
• Use of correct profile on group ticket sales receipt

• Avoid logging error by specific NOD "error code" which is not really an error.

• Removed blank field for fromTariffZoneName in response to ticket distribution groups, traveling between stopPlaces

• Fix filtering on departure reports used by support
• Remove the bug in the same discharge reports
• Prevent incorrect booking of seats on unchanged order lines
• New service showing whether or not to change reservations

• Allow a PaymentTypeGroup to have an empty list of PaymentTypes to handle import payments from AGENT

• Use already created credit if the total credit amount matches when performing a refund

• Better validation on the transaction you are trying to credit when creating Credit

• Just validates PaymentMethods on CAPTURED PaymentTranscations

• Do not create paymentRefs at 0kr unless there is no payment / credit

• Improved receipt text for zone-based products
• Grouping of similar products on receipt