1. Getting Started REST APIREST API for Oracle Loyalty Cloud
  2. Deprecated Paths and Endpoints

Deprecated Paths and Endpoints

Some resource paths and their endpoints have been modified and replaced by other resource paths and endpoints. These replaced resource paths and endpoints, which are unsupported, might be deprecated (removed) in future releases. It is highly recommended that you migrate the unsupported resource paths and endpoints to their replacements as documented in the following topics:

The Loyalty REST APIs were redesigned in order to have a single VO (View Object) for different interfaces such as the REST API, the UI, and the Import facility. The benefits to customers of using consolidated VOs are:

  • Customers get consistent CRUD (Create, Read, Update, Delete) operation behavior across the different interfaces.
  • Extended or modified behavior provided by customers are carried over across the different interfaces.
  • Validations need to be in place only once, at the VO level, and are applied across all interfaces.
  • Duplication is avoided when building the different interfaces.

What Resource Paths and Endpoints Have Changed

The resource paths and endpoints for the following Oracle Loyalty Cloud APIs that are used to create and manage loyalty applications have changed:

  • loyaltyMemberEnrollments
  • loyaltyMembers
  • loyaltyProducts
  • loyaltyPrograms
  • loyaltyPromotions
  • loyaltyTransactions
  • loyaltyVouchers

Note:

Although the resource paths and endpoints that are planned to be deprecated continue to be supported for the near term, these deprecated APIs will become obsolete in the future. Consequently, it is recommended that you migrate your applications to use the new paths and endpoints as documented in this topic, at your earliest convenience. This will minimize any disruption when Oracle Loyalty Cloud no longer supports the deprecated URL structures.

What Resource Paths and Endpoints Are Planned For Deprecation

The following resource paths and endpoints are planned for deprecation in the future.

Endpoints Resource Paths
Loyalty Member Enrollments (Deprecated)
  • /crmRestApi/resources/11.13.0.0/loyaltyMemberEnrollments
  • /crmRestApi/resources/11.13.0.0/loyaltyMemberEnrollments/{LoyPromomemId}
Loyalty Members (Deprecated)
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberAttributes
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberAttributes/{LoyAttribId}
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberContacts
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberContacts/{LoyMemConId}
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/PointBalances
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/PointBalances/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberPromotionAttributes
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberPromotionAttributes/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberPromotions
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberPromotions/{LoyPromomemId}
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberReferrals
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberReferrals/{LoyMemberId}
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberTiers
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberTiers/{MemberTiersUniqID}
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberTransactions
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberTransactions/{LoyTransactionId}
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberVouchers
  • /crmRestApi/resources/11.13.0.0/loyaltyMembers/{MemberNumber}/child/MemberVouchers/{LoyMemVchrId}
Loyalty Products (Deprecated)
  • /crmRestApi/resources/11.13.0.0/loyaltyProducts
  • /crmRestApi/resources/11.13.0.0/loyaltyProducts/{loyaltyProductsUniqID}
Loyalty Programs (Deprecated)
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/CalendarAttributes
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/CalendarAttributes/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/MemberAttributes
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/MemberAttributes/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/MemberFieldAttributes
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/MemberFieldAttributes/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/PointSubTypes/{LoyPtsubtypeId}
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/PointSubTypes
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/PointTotalsAttributes
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/PointTotalsAttributes/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/PointTypes
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/PointTypes/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/ProgramPartners
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/ProgramPartners/{ProgramPartnersUniqID}
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/RedemptionProducts
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/RedemptionProducts/{RedemptionProductsUniqID}
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/TierClasses
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/TierClasses/{LoyTierClsId}
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/TransactionAttributes
  • /crmRestApi/resources/11.13.0.0/loyaltyPrograms/{LoyProgramId}/child/TransactionAttributes/{LoyAttrdefnBId}
Loyalty Promotions (Deprecated)
  • /crmRestApi/resources/11.13.0.0/loyaltyPromotions
  • /crmRestApi/resources/11.13.0.0/loyaltyPromotions/{LoyPromoId}
  • /crmRestApi/resources/11.13.0.0/loyaltyPromotions/{LoyPromoId}/child/PromotionAttributes
  • /crmRestApi/resources/11.13.0.0/loyaltyPromotions/{LoyPromoId}/child/PromotionAttributes/{LoyAttrdefnBId
Loyalty Transactions (Deprecated)
  • /crmRestApi/resources/11.13.0.0/loyaltyTransactions
  • /crmRestApi/resources/11.13.0.0/loyaltyTransactions/{TransactionNumber}
  • /crmRestApi/resources/11.13.0.0/loyaltyTransactions/{LoyTransactionId}/child/AccrualItems
  • /crmRestApi/resources/11.13.0.0/loyaltyTransactions/{LoyTransactionId}/child/AccrualItems/{AccrualItemsUniqID}
  • /crmRestApi/resources/11.13.0.0/loyaltyTransactions/{LoyTransactionId}/child/Promotions
  • /crmRestApi/resources/11.13.0.0/loyaltyTransactions/{LoyTransactionId}/child/Promotions/{LoyPromoId}
  • /crmRestApi/resources/11.13.0.0/loyaltyTransactions/{LoyTransactionId}/child/Promotions/{LoyPromoId}/child/PromotionAttributes
  • /crmRestApi/resources/11.13.0.0/loyaltyTransactions/{LoyTransactionId}/child/Promotions/{LoyPromoId}/child/PromotionAttributes/{PromotionAttributesUniqID}
  • /crmRestApi/resources/11.13.0.0/loyaltyTransactions/{LoyTransactionId}/child/RedemptionItems
  • /crmRestApi/resources/11.13.0.0/loyaltyTransactions/{LoyTransactionId}/child/RedemptionItems/{RedemptionItemsUniqID}
  • /crmRestApi/resources/11.13.0.0/loyaltyTransactions/{LoyTransactionId}/child/TransactionVouchers
  • /crmRestApi/resources/11.13.0.0/loyaltyTransactions/{LoyTransactionId}/child/TransactionVouchers/{LoyMemVchrId
Loyalty Vouchers (Deprecated)
  • /crmRestApi/resources/11.13.0.0/loyaltyVouchers
  • /crmRestApi/resources/11.13.0.0/loyaltyVouchers/{VoucherNumber}

What Resource Paths and Endpoints to Use Now

Use the following resource paths and endpoints for Oracle Loyalty Cloud APIs (loyaltyMemberPromotionEnrollments, loyMembers, loyProducts, loyPrograms, loyPromotions, loyTransactions, loyVouchers ) to create and manage loyalty applications.

Endpoints Resource Paths
Loyalty Members Enrollments
  • /crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments
  • /crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments/{LoyPromomemId}
Loyalty Members
  • /crmRestApi/resources/11.13.18.05/loyMembers /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberAttributes
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberAttributes/{LoyAttribId}
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberContact
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberContact/{LoyMemConId}
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/pointbalances
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/pointbalances/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/PromotionAttributeDetail
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/PromotionAttributeDetail/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/promotions
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/promotions/{LoyPromomemId}
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberReferrals
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberReferrals/{LoyMemberId}
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberTier
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberTier/{MemberTiersUniqID}
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberTransactions
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberTransactions/{LoyTransactionId}
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/vouchers
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/vouchers/{LoyMemVchrId}
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/cards
  • /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/cards/{CardNumber}
Loyalty Products
  • /crmRestApi/resources/11.13.18.05/loyProducts
  • /crmRestApi/resources/11.13.18.05/loyProducts/{loyaltyProductsUniqID}
Loyalty Programs
  • /crmRestApi/resources/11.13.18.05/loyPrograms /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/CalendarAttributes
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/CalendarAttributes/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberAttributes
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberAttributes/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberFieldAttributes
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberFieldAttributes/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointSubTypes/{LoyPtsubtypeId}
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointSubTypes
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointTotalsAttributes
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointTotalsAttributes/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointTypes
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointTypes/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/ProgramPartners
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/ProgramPartners/{ProgramPartnersUniqID}
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/RedemptionProducts
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/RedemptionProducts/{RedemptionProductsUniqID}
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TierClasses
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TierClasses/{LoyTierClsId}
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TransactionAttributes
  • /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TransactionAttributes/{LoyAttrdefnBId}
Loyalty Promotions
  • /crmRestApi/resources/11.13.18.05/loyPromotions /crmRestApi/resources/11.13.18.05/loyPromotions/{LoyPromoId}
  • /crmRestApi/resources/11.13.18.05/loyaltyPromotions/{LoyPromoId}/child/PromotionAttributes
  • /crmRestApi/resources/11.13.18.05/loyaltyPromotions/{LoyPromoId}/child/PromotionAttributes/{LoyAttrdefnBId}
  • /crmRestApi/resources/11.13.18.05/loyaltyPromotions/{LoyPromoId}/child/PromotionIncentiveChoices /
  • crmRestApi/resources/11.13.18.05/loyaltyPromotions/{LoyPromoId}/child/PromotionIncentiveChoices/{LoyAttrdefnBId}
Loyalty Transactions
  • /crmRestApi/resources/11.13.18.05/loyTransactions /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}
  • /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/AccrualItems
  • /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/AccrualItems/{AccrualItemsUniqID}
  • /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Promotions
  • /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Promotions/{LoyPromoId}
  • /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Promotions/{LoyPromoId}/child/PromotionAttributes
  • /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Promotions/{LoyPromoId}/child/PromotionAttributes/{PromotionAttributesUniqID}
  • /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/RedemptionItems
  • /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/RedemptionItems/{RedemptionItemsUniqID}
  • /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Vouchers
  • /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Vouchers/{LoyMemVchrId}
Loyalty Vouchers
  • /crmRestApi/resources/11.13.18.05/loyVouchers
  • /crmRestApi/resources/11.13.18.05/loyVouchers/{VoucherNumber}

Update the Deprecated Endpoints and Attributes

The URL structure to use for accessing a REST resource is https://rest_server_url/resource_path, where rest_server_url is the REST server to contact, and resource_path is the relative path that defines the REST endpoint. The resource_path portion of the URL structure, introduced in Release 11.13.18.10, has undergone modifications. To update the deprecated endpoints and attributes to the new endpoints and attributes, complete the following changes in your Oracle Loyalty Cloud REST applications:

Create a Member or Enroll a Member Into a Program API

The deprecated REST API endpoint is HTTP POST: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyMembers

The minimum required input payload is:

{
"ProgramName": "[Program Name]",
"ContactFirstName":"[Contact First Name]",
"ContactLastName": "[Contact Last Name]",
"MemberName": "[Member Name]",
"EmailAddress": "[Email Address]"
"MobileNumber": "[Mobile Number]"
}

The new loyalty Management REST APIs, introduced in Release 11.13.18.10 contain changes to the API structure, resource names, attribute names and the URL version.

The new REST API endpoint is HTTP POST: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyMembers

The minimum required input payload is:

{
"LoyProgramName": "[Program Name]",
"ContactFirstName": "[Contact First Name]",
"ContactLastName": "[Contact Last Name]",
"MemberEmailAddress": "[Member Email Address]",
"MobileNumber": [Mobile Number],
}

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
ProgramName LoyProgramName Use the LoyProgramName attribute for the input program.
EmailAddress MemberEmailAddress Use the MemberEmailAddress attribute to specify the input email address. Use the EmailAddress attribute to query loyMembers using GET.
AccountType AccountTypeCode Use the AccountTypeCode attribute to specify the input Account Type. For information on which code to look up for AccountTypeCode, invoke lovResourcePath with the following finder: 
fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder
AccrualType AccrualTypeCode Use the AccrualTypeCode attribute to specify the type of member accrual . For information on the possible input values for AccrualTypeCode,, invoke lovResourcePath with the following finder: 
"fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_ACCRU_TYPE
AccountId AccntId Renamed
MemberGroup MemberGrpCode For information on the possible input values for MemberGrpCode, invoke lovResourcePath with the following finder: 
fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_GRP
MemberClass MemberClassCode For information on the possible input values for MemberClassCode,, invoke lovResourcePath with the following finder: 
fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_CLASS
MemberType MemberTypeCode For information on the possible input values for MemberTypeCode, invoke lovResourcePath with the following finder: 
fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_TYPE
Status StatusCode For information on the possible input values for StatusCode, invoke lovResourcePath with the following finder: 
fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder
AccountName LoyAccountName  

Create an Accrual or Redemption Transaction API

The deprecated REST API endpoint is HTTP POST: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyTransactions

The minimum required input payload is:

{ 
"MemberNumber" : [Member Number],
"PartnerNumber": "[Partner Number]",
"ProgramName" : "[Program Name]", 
"PointTypeName" : "[Point Type Name]",
"ProductNumber" : "[Product Number]",
"InvOrgId": [Organization Id],
"AmountValue" : [Amount Value],
"TransactionDate" : "[Transaction Date]",
"Points" : {Points],
"TypeCodeName" : "[Type Code Name]",
"SubTypeName" : "(Subtype Name]"
}

The new loyalty Management REST APIs, introduced in Release 11.13.18.10 contain changes to the API structure, resource names, attribute names and the URL version.

The new REST API endpoint is HTTP POST: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyTransactions

The minimum required input payload is:

{ 
"MemberNumber" : [Member Number],
"ProgramName" : "[Program Name]", 
"PointTypeName" : "[Point Type Name]",
"InvOrgId": [Organization Id],
"ProductNumber" : "[Product Number]",
"AmountValue" : [Amount Value],
"TransactionDate" : "[Transaction Date]",
"Points" : {Points],
"TypeCode" : "[Type Code]",
"SubTypeName" : "(Subtype Name]"
}

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
TypeCodeName TypeCode For information on which code to look up for TypeCode, invoke the following finder: 
lovResourcePath:fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_ACRL_DISPUTE_TYPE
.
SubTypeName SubTypeCode Renamed
FareTypeMeaning FareTypeCode For information on which code to look up for FareTypeCode, invoke the following finder: 
lovResourcePath:fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_TXN_FARE_TYPE
OriginAirportMeaning OrigAirportCode For information on which code to look up for OrigAirportCode, invoke the following finder: 
lovResourcePath:fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_TXN_AIRPORT
DestinationAirportMeaning DestAirportCode For information on which code to look up for DestAirportCode, invoke the following finder: 
lovResourcePath:fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_TXN_AIRPORT
OperFltNumber OperFltNum Renamed
PaymentTypeMeaning PaymentType For information on which code to look up for PaymentType, invoke the following finder: 
lovResourcePath=fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_TXN_PAY_TYPE
SourceMeaning N/A Removed
TravelClassMeaning N/A Removed
TransactionStatusMeaning N/A Removed
SourceMeaning N/A Removed

Retrieve Program Information API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyPrograms

The new loyalty Management REST APIs, introduced in Release 11.13.18.10 contain changes to the API structure, resource names, attribute names and the URL version.

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPrograms

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
ActiveFlg ActiveFlag Renamed
BatRdmPerdDurtn BatchRedemptionPeriodDuration Renamed
BatRdmPerdTpCode BatchRedemptionPeriodTypeCode Renamed
EnableEnrollmentBonus EnableEnrollmentBonusFlag Values changed from Y/N type to Boolean type.
EnableReferralBonus EnableReferralBonusFlag Values changed from Y/N type to Boolean type.
EndDt EndDate Renamed
PartnerFlg PartnerFlag Values changed from Y/N type to Boolean type.
PntToPayFlg PointsToPayFlag Values changed from Y/N type to Boolean type.
PurStrtDayCode PurchaseStartDayCode Renamed
PurStrtMthCode PurchaseStartMonthCode Renamed
RevrecgPeriodDur RevenueRecongnitionPeriodDuration Renamed
RevrecgPrdTypCode RevenueRecongnitionPeriodTypeCode Renamed
ThrshldPointVal ThresholdPointVal Renamed
TxfrStrtDayCode TransferStartDayCode Renamed
TxfrStrtMthCode TransferStartMonthCode Renamed

Retrieve Promotion Information API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyPromotions

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPromotions

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
ActiveFlg ActiveFlag Values changed from Y/N type to Boolean type.
AdministratorFlg AdministratorFlag Values changed from Y/N type to Boolean type.
AlwaysApplyFlg AlwaysApplyFlag Values changed from Y/N type to Boolean type.
ApplyToTiersFlg ApplyToTiersFlag Values changed from Y/N type to Boolean type.
AvlToProcflwFlg AvlToProcflwFlag Values changed from Y/N type to Boolean type.
BasePromoFlg BasePromoFlag Values changed from Y/N type to Boolean type.
DescriptionText Description Renamed
EndDt EndDate Renamed
ExportFlg ExportFlag Values changed from Y/N type to Boolean type.
FinalExecDt FinalExecDate Renamed
OptinEndDt OptinEndDate Renamed
OptInFlg OptInFlag Renamed
OptinStartDt OptinStartDate Renamed
OrderFlg OrderFlag Values changed from Y/N type to Boolean type.
PkgAcrlFlg PkgAcrlFlag Values changed from Y/N type to Boolean type.
PromoNumber PromotionNumber Renamed
PtnrProcDt PartnerProcDate Renamed
PtnrRvwStatCode PartnerReworkStatCode Renamed
PtnrUserId PartnerUserId Renamed
StartDt StartDate Renamed
SubTypeName SubTypeCode The SubType values of a promotion are dependent on the Type values of promotion. To retrieve information for SubTypeCode, invoke the following finder: 
lovResourcePathfndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3D%20
TypeName TypeCode For possible display code and values combination information for SubTypeCode, invoke the following finder: 
lovResourcePathfndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_TXN_TYPE

Retrieve Product Information API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyProducts

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyProducts

There are no changes to the attributes for this API.

Retrieve Child Member Attribute Information for a Member API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyMembers/<MemberNumber>/child/MemberAttributes

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/MemberAttributes

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AttributeName DisplayName Renamed
DescriptionText DescText Renamed
CreatedBy N/A Removed
ConflictId N/A Removed
LastUpdatedBy N/A Removed
LastUpdateLogin N/A Removed

Enroll a Member Into an Enrollable Promotion API

The deprecated REST API endpoint is HTTP POST: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyMembers/loyaltyMemberEnrollments

The minimum required input payload is:

{
"EnrollmentStart": "[Enrollment Start Date]",
"EnrollmentEnd": "[Enrollment End Date]",
"MemberNumber": "[Member Number]",
"PromotionName": "{Promotion Name]"
}

The new loyalty Management REST APIs, introduced in Release 11.13.18.10 contain changes to the API structure, resource names, attribute names and the URL version.

The new REST API endpoint is HTTP POST: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyMembers/MEM_PMEM_2F/child/promotions

The minimum required input payload is:

{ 
"MemberNumber": "[Member Number]", 
"PromotionName": "[Promotion Name]", 
"EnrollmentStart": "[Enrollment Start Date]", 
"EnrollmentEnd": "[Enrollment End Date]" 
}

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
PromotionType TypeCode To retrieve information for PromotionType, invoke the following finder: 
/crmRestApi/resources/11.13.18.05/fndStaticLookups
PromotionSubType SubTypeCode To retrieve information for PromotionSubType, invoke the following finder: 
/crmRestApi/resources/11.13.18.05/fndStaticLookups
Active N/A This attribute has been removed.

Retrieve Child Point Balance Information for a Member API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyMembers/<MemberNumber>/child/PointBalances

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/PointBalances

There are no changes to the attributes for this API

Retrieve Child Member Contact Information for a Member API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyMembers/<MemberNumber>/child/MemberContacts

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/MemberContact

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
EmailAddress N/A Removed
FormattedPhoneNumber N/A Removed
MemberId N/A Removed
PERId PersonId Renamed

Retrieve Child Member Referral Information for a Member API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyMembers/<MemberNumber>/child/MemberReferrals

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/MemberReferrals

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
MemNumber MemberNumber Renamed
Name MemberName Renamed
ReferredById N/A Removed

Create Or Update a Voucher API for a Member

The deprecated REST API endpoint is HTTP POST or PATCH: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyVouchers

The minimum required input payload is:

{
"VoucherType" : "[Voucher Type]",
"MemberNumber": [Member Number],
"ExpirationDt": "[Expeiration Date]",
"voucherStatus" : "[Voucher Status]",
"Quantity" : [Quantity],
"VoucherDiscountValue" : [Voucher Discount Value],
"DiscountType" : "[Discount Type]"
}

The new loyalty Management REST APIs, introduced in Release 11.13.18.10 contain changes to the API structure, resource names, attribute names and the URL version.

The new REST API endpoint is HTTP POST or PATCH: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/vouchers

The minimum required input payload is:

{
"MemberNumber": "[Member Number]", 
"InvOrgId": {Organization Id], 
"ProductNumber": "[Product Number]", 
"ExpirationDt": "[Expiration Date]", 
"VchrBasisCode": "[Voucher Basis Code]", 
"BasisCode": "[Basis Code]", 
"Quantity": [Quantity], 
"CurrencyAmount": [Currency Amonut] 
 }

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
VoucherBasis BasisCode To retrieve information for BasisCode, invoke the following finder: 
fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_BASIS
DiscountType VchrBasisCode To retrieve information for VchrBasisCode, invoke the following finder: 
fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_DISCOUNT_TYPE
voucherStatus StatusCode To retrieve information for StatusCode, invoke the following finder: 
fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_STATUS
VoucherType ProductNumber To identify a product, InvOrgId and ProductNumber should be used.

Retrieve Child Member Transaction Information for a Member API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyMembers/<MemberNumber>/child/MemberTransactions

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/MemberTransactions

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AttributeName DisplayName Renamed
DescriptionText DescText Renamed
CreatedBy N/A Removed
ConflictId N/A Removed
LastUpdatedBy N/A Removed
LastUpdateLogin N/A Removed

Retrieve Child Member Tier Information for a Member API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyMembers/<MemberNumber>/child/MemberTiers

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/MemberTier

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
Active ActiveFlag Values changed from Y/N type to Boolean type.
CurrentTier TierName Renamed
EndDate EndDt Renamed
Nexttiername NextTierName Renamed
Presentqualpoints PresentQualPoints Renamed
StartDate StartDt Renamed
Tierqualpoints TierQualPoints Renamed
Tilldate TillDate Renamed

Create and Update Membership Cards for a Member API

The deprecated REST API endpoint is HTTP POST or PATCH: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyMembershipCards

The new REST API endpoint is HTTP POST or PATCH: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/cards

There are no changes to the attributes for this API

Retrieve Child Promotion Attribute Information for a Member API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyMembers/<MemberNumber>/child/MemberAttributes

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/MemberAttributes

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AttributeName DisplayName Renamed
DescriptionText DescText Renamed
CreatedBy N/A Removed
ConflictId N/A Removed
LastUpdatedBy N/A Removed
LastUpdateLogin N/A Removed

Retrieve Voucher Assignment Information for a Transaction API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyTransactions/<txnid>/child/TransactionVouchers

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyTransactions/<txnid>/child/Vouchers

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
VchrEffStartDt VoucherEffectiveStartDt Renamed
VoucherBasis VchrBasisCode Renamed
VoucherType N/A Removed
TransactionId TxnId Renamed
VoucherStatus StatusCode Renamed
DiscntPct DiscountValue Renamed
CurcyAmount CurrencyAmount Renamed
ProdId N/A Removed

Retrieve Child Bucket Promotion Information for a Transaction API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyTransactions/<TransactionId>/child/Promotions

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyTransactions/<TransactionId>/child/Promotions

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
LoyBucketId BucketUid Renamed
LoyBucketTransactionId N/A Removed
LoyProgId N/A Removed
LoyPromoId PromotionId Renamed
Name N/A Removed

Retrieve Child Calendar Attribute Information for a Program API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyPrograms/ProgramId>/child/CalendarAttributes

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPrograms/ProgramId>/child/CalendarAttributes

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AccntActCode AccountActionCode Renamed
ActiveFlg ActiveFlag Values changed from Y/N type to Boolean type.
CostperPoint CostPERPoint Renamed
CurcyCode CurrencyCode Renamed
CurcyExchDt CurrencyExchDt Renamed
DefaultVal DefaultValue Renamed
DisplayFlg DisplayFlag Values changed from Y/N type to Boolean type.
DynamicFlg DynamicFlag Values changed from Y/N type to Boolean type.
ExpPeriodLen ExpPeriodLength Renamed
MinimumReactivatnQuantity MinimumReactivationQuantity Renamed
QualPointFlg QualPointFlag Values changed from Y/N type to Boolean type.
ReactivateFlg ReactivateFlag Values changed from Y/N type to Boolean type.
ReadonlyFlg ReadonlyFlag Values changed from Y/N type to Boolean type.
RetEffFlg RetEffFlag Values changed from Y/N type to Boolean type.
RptExpPeriodLen RptExpPeriodLength Renamed
PrgFormulaId N/A Removed

Retrieve Child Program Partner Information for a Program API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyPrograms/<ProgramId>/child/ProgramPartners

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramIdr>/child/ProgramPartners

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AllwNegativeFlg AllwNegativeFlag Values changed from Y/N type to Boolean type.
PrecalcAcrlFlg PrecalcAcrlFlag Values changed from Y/N type to Boolean type.
SkipAcrlValFlg SkipAcrlValFlag Values changed from Y/N type to Boolean type.
ValidDisputeFlg ValidDisputeFlag Values changed from Y/N type to Boolean type.

Retrieve Child Transaction Attribute Information for a Program API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyPrograms/<ProgramId>/child/TransactionAttributes

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/TransactionAttributes

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AccntActCode AccountActionCode Renamed
ActiveFlg ActiveFlag Values changed from Y/N type to Boolean type.
CostperPoint CostPERPoint Renamed
CurcyCode CurrencyCode Renamed
CurcyExchDt CurrencyExchDt Renamed
DefaultVal DefaultValue Renamed
DisplayFlg DisplayFlag Values changed from Y/N type to Boolean type.
DynamicFlg DynamicFlag Values changed from Y/N type to Boolean type.
ExpPeriodLen ExpPeriodLength Renamed
MinimumReactivatnQuantity MinimumReactivationQuantity Renamed
QualPointFlg QualPointFlag Values changed from Y/N type to Boolean type.
ReactivateFlg ReactivateFlag Values changed from Y/N type to Boolean type.
ReadonlyFlg ReadonlyFlag Values changed from Y/N type to Boolean type.
RetEffFlg RetEffFlag Values changed from Y/N type to Boolean type.
RptExpPeriodLen RptExpPeriodLength Renamed
PrgFormulaId N/A Removed

Retrieve Child Member Field Attribute Information for a Program API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyPrograms/<ProgramId>/child/MemberFieldAttributes

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/MemberFieldAttributes

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AccntActCode AccountActionCode Renamed
ActiveFlg ActiveFlag Values changed from Y/N type to Boolean type.
CostperPoint CostPERPoint Renamed
CurcyCode CurrencyCode Renamed
CurcyExchDt CurrencyExchDt Renamed
DefaultVal DefaultValue Renamed
DisplayFlg DisplayFlag Values changed from Y/N type to Boolean type.
DynamicFlg DynamicFlag Values changed from Y/N type to Boolean type.
ExpPeriodLen ExpPeriodLength Renamed
MinimumReactivatnQuantity MinimumReactivationQuantity Renamed
QualPointFlg QualPointFlag Values changed from Y/N type to Boolean type.
ReactivateFlg ReactivateFlag Values changed from Y/N type to Boolean type.
ReadonlyFlg ReadonlyFlag Values changed from Y/N type to Boolean type.
RetEffFlg RetEffFlag Values changed from Y/N type to Boolean type.
RptExpPeriodLen RptExpPeriodLength Renamed
PrgFormulaId N/A Removed

Retrieve Child Member Attribute Information for a Program API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyPrograms/<ProgramId>/child/MemberAttributes

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/MemberAttributes

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AccntActCode AccountActionCode Renamed
ActiveFlg ActiveFlag Values changed from Y/N type to Boolean type.
CostperPoint CostPERPoint Renamed
CurcyCode CurrencyCode Renamed
CurcyExchDt CurrencyExchDt Renamed
DefaultVal DefaultValue Renamed
DisplayFlg DisplayFlag Values changed from Y/N type to Boolean type.
DynamicFlg DynamicFlag Values changed from Y/N type to Boolean type.
ExpPeriodLen ExpPeriodLength Renamed
MinimumReactivatnQuantity MinimumReactivationQuantity Renamed
QualPointFlg QualPointFlag Values changed from Y/N type to Boolean type.
ReactivateFlg ReactivateFlag Values changed from Y/N type to Boolean type.
ReadonlyFlg ReadonlyFlag Values changed from Y/N type to Boolean type.
RetEffFlg RetEffFlag Values changed from Y/N type to Boolean type.
RptExpPeriodLen RptExpPeriodLength Renamed
PrgFormulaId N/A Removed

Retrieve Child Point Type Information for a Program API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyPrograms/<ProgramId>/child/PointsTypes

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/PointTypes

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AccntActCode AccountActionCode Renamed
ActiveFlg ActiveFlag Values changed from Y/N type to Boolean type.
CostperPoint CostPERPoint Renamed
CurcyCode CurrencyCode Renamed
CurcyExchDt CurrencyExchDt Renamed
DefaultVal DefaultValue Renamed
DisplayFlg DisplayFlag Values changed from Y/N type to Boolean type.
DynamicFlg DynamicFlag Values changed from Y/N type to Boolean type.
ExpPeriodLen ExpPeriodLength Renamed
MinimumReactivatnQuantity MinimumReactivationQuantity Renamed
QualPointFlg QualPointFlag Values changed from Y/N type to Boolean type.
ReactivateFlg ReactivateFlag Values changed from Y/N type to Boolean type.
ReadonlyFlg ReadonlyFlag Values changed from Y/N type to Boolean type.
RetEffFlg RetEffFlag Values changed from Y/N type to Boolean type.
RptExpPeriodLen RptExpPeriodLength Renamed
PrgFormulaId N/A Removed

Retrieve Child Tier Class Information for a Program API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyPrograms/<ProgramId>/child/TierClasses

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/TierClasses

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
ActiveFlg ActiveFlag Renamed
ApplyFlg ApplyFlag Renamed
MinimumTierLen MinimumTierLength Renamed
QualPdUOMCode QualPeriodUOMCode Renamed
QualPeriodLen QualPeriodLength Renamed
RequalPeriodLen RequalPeriodLength Renamed
RestartQualPdCode RestartQualPeriodCode Renamed
SequenceNo SequenceNumber Renamed
StartQualPdCode StartQualPeriodCode Renamed
STQualPdDayCode STQualPeriodDayCode Renamed
STQualPdMthCode STQualPeriodMonthCode Renamed
STTierPdDayCode STTierPeriodDayCode Renamed
STTierPdMthCode STTierPeriodMonthCode Renamed

Retrieve Child Point Subtype Information for a Program API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyPrograms/<ProgramId>/child/PointSubTypes

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/PointSubTypes

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
DefaultFlg DefaultFlag Renamed
conflictId N/A Removed

Retrieve Child Redemption Products Information for a Program API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyPrograms/<ProgramId>/child/RedemptionProducts

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/RedemptionProducts

There are no changes to the attributes for this API

Retrieve Child Point Total Attribute Information for a Program API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyProgram/<ProgramId>/child/PointTotalsAttributes

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/PointTotalsAttributes

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AccntActCode AccountActionCode Renamed
ActiveFlg ActiveFlag Values changed from Y/N type to Boolean type.
CostperPoint CostPERPoint Renamed
CurcyCode CurrencyCode Renamed
CurcyExchDt CurrencyExchDt Renamed
DefaultVal DefaultValue Values changed from Y/N type to Boolean type.
DisplayFlg DisplayFlag Values changed from Y/N type to Boolean type.
DynamicFlg DynamicFlag Renamed
ExpPeriodLen ExpPeriodLength Renamed
MinimumReactivatnQuantity MinimumReactivationQuantity Renamed
QualPointFlg QualPointFlag Values changed from Y/N type to Boolean type.
ReactivateFlg ReactivateFlag Values changed from Y/N type to Boolean type.
ReadonlyFlg ReadonlyFlag Values changed from Y/N type to Boolean type.
RetEffFlg RetEffFlag Values changed from Y/N type to Boolean type.
RptExpPeriodLen RptExpPeriodLength Renamed
PrgFormulaId N/A Removed

Retrieve Child Promotion Attribute Information for a Promotion API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyPromotions/<PromotionId>/child/PromotionAttributes

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyPromotions/<PromotionId>/child/PromotionAttributes

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AccntActCode AccountActionCode Renamed
ActiveFlg ActiveFlag Values changed from Y/N type to Boolean type.
CostperPoint CostPERPoint Renamed
CurcyCode CurrencyCode Renamed
CurcyExchDt CurrencyExchDt Renamed
DefaultVal DefaultValue Renamed
DisplayFlg DisplayFlag Values changed from Y/N type to Boolean type.
DynamicFlg DynamicFlag Values changed from Y/N type to Boolean type.
ExpPeriodLen ExpPeriodLength Renamed
MinimumReactivatnQuantity MinimumReactivationQuantity Renamed
QualPointFlg QualPointFlag Values changed from Y/N type to Boolean type.
ReactivateFlg ReactivateFlag Values changed from Y/N type to Boolean type.
ReadonlyFlg ReadonlyFlag Values changed from Y/N type to Boolean type.
RetEffFlg RetEffFlag Values changed from Y/N type to Boolean type.
RptExpPeriodLen RptExpPeriodLength Renamed
PrgFormulaId N/A Removed

Retrieve Child Accrual Items for a Transaction API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyTransactions/<TransactionId>/child/AccrualItems

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyTransactions/<TransactionId>/child/AccrualItems

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AmountValue TransactionAmount Renamed
LoyAttrdefnBId N/A Removed
LoyPromoId N/A Removed
LoyTransactionId N/A Removed
PointTypeId N/A Removed
PointTypeName DisplayName Renamed
ProgId N/A Renamed
PromoId N/A Renamed
TransactionId N/A Renamed

Retrieve Child Redemption Items for a Transaction API

The deprecated REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.0.0/loyaltyTransactions/<TransactionId>/child/RedemptionItems

The new REST API endpoint is HTTP GET: 

https://<server_name:port>/crmRestApi/resources/11.13.18.05/loyTransactions/<TransactionId>/child/RedemptionItems

Due to structural changes in the Oracle Loyalty Cloud REST APIs, the attributes names have changed from the deprecated API to the new API as shown in the following table.

Deprecated Attribute Name New Attribute Name Attribute Notes
AccrualItemId N/A Removed
LoyAttrdefnBId N/A Removed
LoyPromoId N/A Removed
LoyTransactionId N/A Removed
PointTypeId N/A Removed
ProcessDt ProcessDate Renamed