Personalisation Program Administration API Changelog

Added fieldTranslations to DataSource, LookupTable and LookupVariable This property can be used to specify translation of fields to different languages.

It is now required to provide language nb-NO for field translations.

Added PointDefinition property translations This property can be used to specify translation of point definition fields to different languages.

Make it possible to match an intentReference to multiple paths in the trigger event data.

Data source type "HTTP" has been removed. Use "HTTP_EVENT" instead.

Deprecate point expiry trigger "DURATION_FROM_EARLIEST_ACTIVE_POINT". Point expiry trigger "PERIODIC" should be used instead.

Endpoint for creating transactions has been removed

suspensionId has been deprecated for SuspensionPeriod, replaced with referenceId. suspensionIdPath has been deprecated for SuspendRewards and SuspendEffects in Trigger, replaced with referenceIdPath

Removed the property customerIdPath from data sources, and made the same property required in all effects

Added the program property rewardCalculationTime The property can be set to specify if offer time or travel time should be used when calculating rewards. It is optional, and if not set, the default value offer time: the time at which the offer calculation starts.

Added endpoints /v1/programs/{programId}/expression-variables for maintaining variables that can be used in expressions Expression variables are intended for simplifying condition expressions in term of readability.

Added metadata json schema to point definition, with mapping to metadata fields in GivePoint. This is used to add metadata to transactions when member is given points.

Added Json Schema to data sources definition. Only applicable for HTTP-events

Added endpoints /v1/programs/{programId}/lookup-tables for maintaining key/value tables that can be used in expressions by a new custom function NUMBER_LOOKUP Input to NUMBER_LOOKUP are a table reference (string) and a search key. Return value is a number. NUMBER_LOOKUP is intended to be used as a tool to avoid hardcoding and to simplify program conditions.

Renamed properties in effect configuration AddMember and UpdateMemberMetadata in Trigger Property memberMetadata has been renamed to memberMetadataMapping in AddMember and UpdateMemberMetadata in Trigger. The purpose is to better represent what the property is used for. The model MemberMetadata has been renamed to MemberMetadataValueMapping, The property valuePath in MemberMetadataValueMapping has been renamed to valueMapping, and the type has been changed from String to JsonNode.

Added new configuration MemberMetadataDefinition This new configuration can be used to define member metadata with condition and validation on those data for the program. All effects that manipulates the member metadata (i.e. UpdateMemberMetadata and AddMember) will need a valid mapping from the metadata definition to the metadata value. A program can have multiple member metadata definitions, with field name as the identifier. This means the field name must be unique within the program.

Removed the endpoints under /v1/programs/{programId}/level. Instead, to view or update the reward ladder levels of a program, use /v1/programs/{programId}/reward-ladder`. This endpoint will return all of the levels in the program.

Added new effect UpdateMemberMetadata This new effect can be used to update member metadata. This should have the same condition as the AddMember effect in the program. It is not possible to update the customer ID or organisation ID for a member

Added optional property rewardPercentDiscountExpressions on Level. It can be used to calculate which percentage reward the level should give in a set of available rewards. The expression must be in EvalEx-format.
If rewardIdsis also set, the level will always give those rewards, in addition to the calculated rewards.

Added optional property requiredAmountExpression on LevelRequirement. It can be used instead of requiredAmount to define a dynamic requirement for achieving a level. The expression must be in EvalEx-format. requiredAmount is made optional, but either requiredAmount or requiredAmountExpression must be set.

Added new capability "Capping". Capping is a capability that can be used to cap the amount of points that can be accumulated for a given point definition for a member.

Added RewardLadder that holds all levels connected to a specific program This includes new endpoints to get and edit reward ladder: * GET /v1/programs/{programId}/reward-ladder * PUT /v1/programs/{programId}/reward-ladder

Added property isProgramSpecific on DataSource. It is a boolean that returns true if the data source is specific to a program, and false if it is a system data source that can be used by all programs.

  New endpoints for managing system data sources have been added at `v1/data-sources. 

Added new configuration property rewardRecipients on PercentDiscountedProductReward. It is an enum property that determines who should be granted the reward. It has the values:* ENTITLED_TRAVELLER. Gives the reward only to the customer that has the right to the reward, either through a campaign code or their achieved level. This is also the existing behavior of the system, and the default value.

• ALL_TRAVELLERS_IN_PARTY: Gives the reward both to the customer that has the right to the reward, and to the other travellers they purchase the ticket for.

Added activation periods to CampaignCode. When activation periods are present, the periods will limit when a campaign code can be used. An activation period is defined by a start time and an end time. The campaign code can be used when period start time <= current time < period end time. If period end time is undefined, the campaign code can be used indefinitely. If the campaign code program is disabled, the campaign code cannot be used.

Added point expiry trigger DURATION_FROM_EARLIEST_ACTIVE_POINT. This expiry trigger makes points last a duration, as specified with the pointExpiryDuration, from the earliest active point when the new point is evaluated. If no active point exist, the base date is given from the new point. For example, if the pointExpiryDuration is set to 7 days:

• Point 1 given 2024-02-06 12:00, expires 2024-02-13 12:00.
• Point 2 given 2024-02-08 12:00, also expires 2024-02-13 12:00, since point 1 is active
• Point 3 given 2024-02-13 11:00, also expires 2024-02-13 12:00, since point 1 is active
• Point 4 given 2024-02-13 13:00, expires 2024-02-20 13:00, since point 1 is no longer active, starting a new period. The effect is that points will be "grouped" in validity into periods of 7 days.

Added validFrom on Transaction. This field indicates when the transaction starts to be valid. It is filled out using the pointExpiryBaseDatePath on the GivePoint effect. Existing transactions will have validFrom set to the same value as createdAt.

Added new custom functions that can be used in expressions when evaluating trigger conditionsand GivePoint effects.

• LENGTH: Returns the length of the input. Input can be a string, an array or a structure. Otherwise returns 0.
• FILTER_BY_JSON_PATH: Takes in an array and a json path expression and returns an array. The returning arrayonly contains the elements in the original array that match the json path expression.
• SUM_BY_JSON_PATH: Takes in an array and a json path expression and returns a number. The returning numberis the sum of the values found by applying the json path expression on each of the values in the array.

Added capability to indicate when your program is eligible for giving points.Use the endpoint /v1/programs/{programId}/accrual-conditions.The programs that are eligible will show up in responses from "offers" in "eligibleForAccrualInPrograms".

Added query parameter "hasCampaignCodes" to getPrograms, which will only retrieve programs with Campaign Codes.

Added reference to PointDefinition. This reference is unique to the point definition in the program and enables clients to identify the point definition semantically,in order to augment the presentation of the point with their own data, such as an icon or more descriptive text.The reference is also included as part of the CurrentLevelSummary, in pointDefinitionStatuses, as a new field pointDefinitionReference.pointDefinitionStatuses also also been extended to always return all point definitions in the program, even if the member has no points of it.Added new effect RevokePoint. This new effect can be used to revoke points previously given with the GivePoint effect. The effect requires a referenceIdPath from the event,and a pointDefinitionId. When executed, the effect will revoke the points that matches the referenceId and pointDefinitionId.

Added pointExpiryBaseDatePath to GivePoint effect. Used to define the date that expiry of points is calculated from. See API documentation for more info.

Added referenceId to Transaction. A unique id that points back to the event that created the transaction. How this field is populated is configured using the new referenceIdPath field on the GivePoints effect. Default value is null.

Added SuspensionPeriod as a new resource under member. Returns when the member is suspended from for example getting points, or discounts

Removed "programId" from DataSource, PointDefinition, Reward, Level, Transaction, Member. The programId is already known from the path.