Update a loyalty member
patch
/crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}
Request
Path Parameters
-
MemberNumber(required): string
The member number. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
AccntId: integer
(int64)
Title:
Account ID
The account identifier for the member's partner object of the member referred by current member. If the MemberType attribute is set to Company, then Oracle Loyalty Cloud populates AccountId. This attribute depends on the value of the MemberType attribute. There is no default value or limitation with this attribute. -
AccrualStartDate: string
(date-time)
Title:
Accrual Start Date
The date when the member starts accruing points from another member. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
AccrualToHouseholdFlag: string
Title:
Accrual to Household
This flag determines whether the accrual due to a transaction completed by a household member should be accrued to a member or to the household to which it belongs. There is no default value associated with this attribute. -
AccrualToMemId: integer
(int64)
Title:
Accrual-to Member ID
The identifier of the member to whose account the points are accrued for a corporate accrual. This attribute shows information about the referred member. This attribute value depends on the AccrualType attribute. There is no default value or limitation associated with this attribute. -
AccrualTypeCode: string
Title:
Accrual Type
Maximum Length:30
The accrual type value, that is an LOV attribute which is based on FND lookups. This attribute shows information about the referred member. For the possible input values of AccrualTypeCode, the integrating user must first invoke the corresponding LOV resource path URL. For example: invoke lovResourcepath ../crmRestApi/resources/11.12.0.0/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_ACCRU_TYPE. There is no default value, dependency, or limitation associated with this attribute. -
activities: array
Activities
Title:
Activities
The activities resource is used to retrive the details of activities associted with the loyalty members. -
cards: array
Cards
Title:
Cards
The cards resource is used to retrieve the details of membership cards for the given loyalty member. -
ContactId: integer
(int64)
Title:
Contact ID
The contact identifier as specified in the Member Contacts object. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactName: string
Title:
Contact
Maximum Length:450
The name of the contact associated with the member. This attribute shows information about the referred member. This attribute has the format of ContactFirstName ContactLastName. There is no default value, dependency, or limitation associated with this attribute. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The currency code used by the corporation. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CorpMemberNumber: string
Title:
Corporation Member Number
Maximum Length:15
The corporate member number. If the current member is part of the company or corporate account, then Oracle Loyalty Cloud populates this field. This is an optional attribute which is introduced for future use. Oracle Loyalty Cloud does not currently use this attribute. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CreationSource: string
Title:
Creation Source
The information detailing the member creation source. This attribute value is set while creating a member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate method that is applied. This rate can apply to an individual or throughout the corporation. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The international currency code used by the loyalty member to complete transactions. International codes such as USD, INR,GBP are valid for this attribute. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyDate: string
(date)
Title:
Currency Date
The date when the currency conversion rate is applied for a given currency code. There is no default value, dependency, or limitation associated with this attribute. -
groupMembers: array
Group Members
Title:
Group Members
The group members resource is used to retrieve the details of a group member attribute associated with the loyalty member. -
HouseholdMemberNumber: string
Title:
Household Member Number
The member number of a household to be passed by a payload. This value should be a valid household enrolled already in the same loyalty program. There is no default value associated with this attribute. -
individualMembers: array
Individual Members
Title:
Individual Members
The individual members resource is used to retrieve the details of an individual member attribute associated with the loyalty member. -
JobTitle: string
Title:
Job Title
The job title of a contact which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
LastAccrTransactionDt: string
(date-time)
Title:
Last Accrual Transaction Date
The date when the last accrual transaction for the loyalty member has occurred. There is no default value, dependency, or limitation associated with this attribute. -
LastRdmTransactionDt: string
(date-time)
Title:
Last Redemption Transaction Date
The last redemption transaction date. This attribute shows when the last redemption transaction by the member has occurred. There is no default value, dependency, or limitation associated with this attribute. -
LastTransactionProcedDt: string
(date-time)
Title:
Last Transaction Processed Date
The last transaction process date. This date shows when the last transaction was performed by the loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeAVal: number
Title:
Lifetime Payment Type A Value
The member's life time point balance in internal point type A. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeBVal: number
Title:
Lifetime Payment Type B Value
The member's life time point balance in internal point type B. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeCVal: number
Title:
Lifetime Payment Type C Value
The member's life time point balance in internal point type C. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeDVal: number
Title:
Lifetime Payment Type D Value
The member's life time point balance in internal point type D. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeEVal: number
Title:
Lifetime Payment Type E Value
The member's life time point balance in internal point type E. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeFVal: number
Title:
Lifetime Payment Type F Value
The member's life time point balance in internal point type F. A program can have up to eight point types, internally referred to as Point type (A to H). Each of the point type has a life time point balance associated with it which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeGVal: number
Title:
Lifetime Payment Type G Value
The member's life time point balance in internal point type G. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeHVal: number
Title:
Lifetime Payment Type H Value
The member's life time point balance in internal point type H. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LoyAccountName: string
Title:
Account Name
The loyalty member account name for the member's partner object. If the MemberTypeCode attribute is Company, then Oracle Loyalty Cloud populates the account name. This attribute depends on the value of the MemberTypeCode attribute. Oracle Loyalty Cloud populates the AccountName attribute based on the AccountId attribute. There is no default value or limitation associated with this attribute. -
LoyHouseholdName: string
Title:
Household Name
The household member name. If the MemberTypeCode attribute is set to Household, then this attribute shows membership information about the referred household. There is no default value, dependency, or limitation associated with this attribute. -
LoyMemberId: integer
(int64)
Title:
Loyalty Member ID
The primary key of member referred by current loyMember resource. There is no default value, dependency, or limitation associated with this attribute. -
LstTierChangeDt: string
(date-time)
Title:
Date of Member's Last Tier Change
The date when the member's tier change occurs. Oracle Loyalty Cloud updates this date when a member's tier changes. There is no default value, dependency, or limitation associated with this attribute. -
MemberAttributes: array
Member Attributes
Title:
Member Attributes
The member attributes resource is used to retrieve the details of a member attribute associated with the loyalty member. -
MemberClassCode: string
Title:
Member Class
Maximum Length:30
The FND lookup code value of Member Class as an input of loyalty Members. The possible input values can be obtained by invoking the corresponding lovResourcePath URL: fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_CLASS. -
MemberContact: array
Member Contacts
Title:
Member Contacts
The member contact resource is used to retrieve the details of a contact that is associated with the loyalty member. -
MemberGrpCode: string
Title:
Member Group
Maximum Length:30
The extended Lookup Type attribute of type ORA_LOY_MEM_GRP which shows information about the member's current group. There is no default value, dependency, or limitation associated with this attribute. -
MemberName: string
Title:
Member Name
Maximum Length:100
The name of the referred loyalty member, which can be provided as input while creating a loyalty member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
MemberPhaseCode: string
Title:
Member Phase
Maximum Length:30
The lookup code value of the member phase used as a an input for loyalty Members. The integrating user must first invoke the lovResourcepath URL for possible input values. The corresponding lovResourcePath URL is ?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_PHASE. There is no default value, dependency, or limitation associated with this attribute. -
MemberReferrals: array
Member Referrals
Title:
Member Referrals
The member referrals resource is used to retrieve the contacts that are referred by the loyalty member. -
MembershipSchemeId: integer
(int64)
Title:
Membership Scheme ID
The unique reference to the member scheme, if any, chosen by the user while enrolling into the loyalty program. The member scheme can be a paid or free scheme. For example, a 6 months free membership, or a 1 Year $5 paid membership, and so on. There is no default value, dependency, or limitation associated with this attribute. -
MemberTier: array
Member Tiers
Title:
Member Tiers
The member tier resource is used to retrieve the member tier details for the loyalty member. -
MemberTransactions: array
Member Transactions
Title:
Member Transactions
The member transactions resource is used to retrieve the details of transactions performed by the loyalty member. -
MemberTypeCode: string
Title:
Type
Maximum Length:30
Default Value:ORA_MEM_TYPE_INDIVIDUAL
The member type, which is provided as an input attribute while creating a loyalty member. To know the possible input values, the user must invoke the corresponding lovResourcePath URL ....fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_TYPE. There is no default value, dependency, or limitation associated with this attribute. -
OrgGroupId: integer
(int64)
Title:
Organization Group ID
The organization group identifier to which the loyalty member belongs. There is no default value, dependency, or limitation associated with this attribute. -
ParentMember: string
Title:
Parent
Maximum Length:1
Default Value:N
The parent member where the loyalty member is either a household or an individual, but is also a corporate member. There is no default value, dependency, or limitation associated with this attribute. -
PartyName: string
Title:
Contact Party Name
Maximum Length:360
The loyalty partner name as an alternative identifier. Oracle Loyalty Cloud creates this identifier when a loyalty membership is created through a partner as a reference. There is no default value, dependency, or limitation associated with this attribute. -
PersonName: string
Title:
Person Name
Maximum Length:450
The full name of the member contact. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same LastName attribute can be used while enrolling a member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
pointbalances: array
Point Balances
Title:
Point Balances
The point balances resource is used to retrieve the point balance detail for a loyalty member. -
pointItems: array
Point Items
Title:
Point Items
The point items resource is used to retrieve the point items detail for a loyalty member. -
PointTypeAVal: number
Title:
Point Type A Value
Default Value:0
The points for the member from Point Type A as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeBVal: number
Title:
Point Type B Value
Default Value:0
The points for the member from Point Type B as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeCVal: number
Title:
Point Type C Value
Default Value:0
The points for the member from Point Type C as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeDVal: number
Title:
Point Type D Value
Default Value:0
The points for the member from Point Type D as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeEVal: number
Title:
Point Type E Value
Default Value:0
The points for the member from Point Type E as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeFVal: number
Title:
Point Type F Value
Default Value:0
The points for the member from Point Type F as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeGVal: number
Title:
Point Type G Value
Default Value:0
The points for the member from Point Type G as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeHVal: number
Title:
Point Type H Value
Default Value:0
The points for the member from Point Type H as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PrConId: integer
(int64)
Title:
Primary Contact ID
The partner contact identifier. This value can be provided as an input while creating a loyalty member through the resource and when Oracle Loyalty Cloud enrols the corresponding contact as a member in the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PromotionAttributeDetail: array
Promotion Attribute Details
Title:
Promotion Attribute Details
The promotion attribute detail resource is used to retrieve the details of a member promotion attribute associated with the loyalty member. -
promotions: array
Promotions
Title:
Promotions
The promotions resource is used to retrieve the details of a promotion enrolled by the loyalty member. -
RealTimeBonusFlag: boolean
Title:
Real Time Bonus
Maximum Length:1
Default Value:false
The real time bonus flag. If this flag is set to Y, then on member enrollment, it processes enrollment and referral bonus transactions in real time. Otherwise, it will create an enrollment bonus and referral bonus transaction and set the status to Queued for the batch engine to pick and process. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByNam: string
Title:
Referred By
Maximum Length:100
The member identifier of the referring member name who has referred the current member to the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByName: string
Title:
Referred By
The member identifier by name who has referred the current member to the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByNumber: string
Title:
Referred by Number
Maximum Length:30
The member number of the member who has referred the current member to the loyalty program. This value is input by the user and is validated against the existing member record in Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
RelationshipId: integer
(int64)
Title:
Relationship ID
The relationship identifier which shows the relationship between loyalty members. There is no default value, dependency, or limitation associated with this attribute. -
reltype: string
Title:
Relationship Type
The relationship type showing the type of relation between loyalty members. For example, there might be a relationship between an organization and a member. There is no default value, dependency, or limitation associated with this attribute. -
StartDate: string
(date-time)
Title:
Joining Date
The date when the membership in the loyalty program starts. There is no default value, dependency, or limitation associated with this attribute. -
Status: string
Title:
Status Meaning
Maximum Length:80
The member status meaning of referred loyalty member which is a read-only value based on the Status code attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_STATUS lookup. There is no default value or limitation associated with this attribute. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:ORA_MEM_STATUS_ACTIVE
The status code of the loyalty member, which is a read-only value based on the Status attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_STATUS lookup. There is no default value or limitation associated with this attribute. -
SuppressCall: string
Title:
Suppress Call
The attribute indicates that the member does not want to receive any calls pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressCallFlag: boolean
Title:
Block Member Call Contact
Maximum Length:1
Default Value:false
Block Member Call Contact. -
SuppressEmail: string
Title:
Suppress Email
The attribute indicates that the member does not want to receive any mail pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressEmailFlag: boolean
Title:
Block Member Email Contact
Maximum Length:1
Default Value:false
Block Member Email Contact. -
SuppressFax: string
Title:
Suppress Fax
The attribute indicates that the member does not want to receive any fax pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressFaxFlag: boolean
Title:
Block Member Fax Contact
Maximum Length:1
Default Value:false
Block Member Fax Contact. -
SuppressMail: string
Title:
Suppress Mail
The attribute indicates that the member does not want to receive any mail pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressMailFlag: boolean
Title:
Block Member Mail Contact
Maximum Length:1
Default Value:false
Block Member Mail Contact. -
SuppressSMS: string
Title:
Suppress SMS
The attribute indicates that the member does not want to receive any SMS pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressSMSFlag: boolean
Title:
Block Member SMS Contact
Maximum Length:1
Default Value:false
Block Member SMS Contact. -
URL: string
The member URL which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute.
-
ValLifeScore: string
Title:
Lifetime Value Score
Maximum Length:50
The life time value score of the loyalty member as the highest watermark value. There is no default value, dependency, or limitation associated with this attribute. -
vouchers: array
Vouchers
Title:
Vouchers
The vouchers resource is used to retrieve the vouchers that are assigned to the loyalty member.
Nested Schema : Activities
Type:
array
Title:
Activities
The activities resource is used to retrive the details of activities associted with the loyalty members.
Show Source
Nested Schema : Cards
Type:
array
Title:
Cards
The cards resource is used to retrieve the details of membership cards for the given loyalty member.
Show Source
Nested Schema : Group Members
Type:
array
Title:
Group Members
The group members resource is used to retrieve the details of a group member attribute associated with the loyalty member.
Show Source
Nested Schema : Individual Members
Type:
array
Title:
Individual Members
The individual members resource is used to retrieve the details of an individual member attribute associated with the loyalty member.
Show Source
Nested Schema : Member Attributes
Type:
array
Title:
Member Attributes
The member attributes resource is used to retrieve the details of a member attribute associated with the loyalty member.
Show Source
Nested Schema : Member Contacts
Type:
array
Title:
Member Contacts
The member contact resource is used to retrieve the details of a contact that is associated with the loyalty member.
Show Source
Nested Schema : Member Referrals
Type:
array
Title:
Member Referrals
The member referrals resource is used to retrieve the contacts that are referred by the loyalty member.
Show Source
Nested Schema : Member Tiers
Type:
array
Title:
Member Tiers
The member tier resource is used to retrieve the member tier details for the loyalty member.
Show Source
Nested Schema : Member Transactions
Type:
array
Title:
Member Transactions
The member transactions resource is used to retrieve the details of transactions performed by the loyalty member.
Show Source
Nested Schema : Point Balances
Type:
array
Title:
Point Balances
The point balances resource is used to retrieve the point balance detail for a loyalty member.
Show Source
Nested Schema : Point Items
Type:
array
Title:
Point Items
The point items resource is used to retrieve the point items detail for a loyalty member.
Show Source
Nested Schema : Promotion Attribute Details
Type:
array
Title:
Promotion Attribute Details
The promotion attribute detail resource is used to retrieve the details of a member promotion attribute associated with the loyalty member.
Show Source
Nested Schema : Promotions
Type:
array
Title:
Promotions
The promotions resource is used to retrieve the details of a promotion enrolled by the loyalty member.
Show Source
Nested Schema : Vouchers
Type:
array
Title:
Vouchers
The vouchers resource is used to retrieve the vouchers that are assigned to the loyalty member.
Show Source
Nested Schema : loyMembers-cards-item-patch-request
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
The attribute indicates whether a member card is active or inactive. There is no default value, dependency, nor limitation associated with this attribute. -
CardStatus: string
Title:
Card Status
The card status attribute specifies the status of the membership card. The possible values are Active, Stolen, Expired, Lost, and so on. Oracle Loyalty Cloud checks the membership card validity during accrual processing or when the membership card is being used for any rewards, based on the membership card status and the expiry date. There is no default value, dependency, or limitation associated with this attribute. -
CardType: string
Title:
Card Type Meaning
The attribute specifies the membership card type. The accepted values are Gold, Platinum, Silver, and so on. Based on the card type, members are entitled to different rewards. For example, in the airline industry, members usually show their membership cards to prove their tier status in order to be able to use special lounges. There is no default value, dependency, or limitation associated with this attribute. -
CardTypeCode: string
Title:
Card Type
Maximum Length:30
The member card type code which shows values based on lookup type ORA_LOY_MEM_CARD_TYPE. There is no default value or limitation associated with this attribute. -
ExpiryDate: string
(date-time)
Title:
Expiration Date
The expiry date attribute specifies when the membership card expires. There is no default value, dependency, or limitation associated with this attribute. -
ExpiryDateOnCard: string
(date-time)
Title:
Expiration Date on Card
The expiration date displayed on the card that specifies when the membership card expires. There is no default value, dependency, or limitation associated with this attribute. -
IssueDate: string
(date-time)
Title:
Issued Date
The issue date attribute specifies when the membership card is issued. There is no default value, dependency, or limitation associated with this attribute. -
NameOnCard: string
Title:
Name on Card
Maximum Length:50
The member name that is displayed on the membership card. There is no default value, dependency, or limitation associated with this attribute. -
RequestDate: string
(date-time)
Title:
Requested Date
The date when a request is placed for receiving the membership card. There is no default value, dependency, or limitation associated with this attribute. -
StartDate: string
(date-time)
Title:
Start Date
The date when the membership card is valid, after when the card can be used to receive rewards or special lounge services, and so on, based on the card type. There is no default value, dependency, or limitation associated with this attribute. -
StatusCode: string
Title:
Status
Maximum Length:30
The member card status code which shows values based on ORA_LOY_MEM_CARD_STATUS. There is no default value or limitation associated with this attribute.
Nested Schema : loyMembers-groupMembers-item-patch-request
Type:
Show Source
object
-
AssociationEndDate: string
(date)
Title:
Association End Date
The association end date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute. -
AssociationStartDate: string
(date)
Title:
Association Start Date
The association start date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute. -
MemberAssociationId: integer
(int64)
Title:
Member Association ID
The member association identifier of the corporate member. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyMembers-individualMembers-item-patch-request
Type:
Show Source
object
-
AssociationEndDate: string
(date)
Title:
Association End Date
The association end date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute. -
AssociationStartDate: string
(date)
Title:
Association Start Date
The association start date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute. -
MemberAssociationId: integer
(int64)
Title:
Member Association ID
The member association identifier of the corporate member. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyMembers-MemberAttributes-item-patch-request
Type:
Show Source
object
-
AttribDefnId: integer
(int64)
Title:
Attribute Definition ID
The attribute definition identifier of the member attribute. This is the identifier for the point type definition. There is no default value, dependency, or limitation associated with this attribute. -
LoyAttribId: integer
(int64)
Title:
Loyalty Attribute ID
The primary key of the member attribute object. Oracle Loyalty Cloud generates this attribute value during the creation of a new member attribute. There is no default value, dependency, or limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member ID
The member identifier to which this member attribute belongs. There is no default value, dependency, or limitation associated with this attribute. -
Value: string
Title:
Value
Maximum Length:250
The member attribute value after the Oracle Loyalty Cloud engine updates the member-level attribute value based on bucket processing or by applying loyalty promotions that updates the value of attribute. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyMembers-MemberContact-item-patch-request
Type:
Show Source
object
-
LoyMemConId: integer
(int64)
Title:
Loyalty Member Contact ID
The member contact identifier. The primary Identifier for referring a Oracle Sales Cloud contact that is enrolled as a loyalty member in a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PersonId: integer
(int64)
The member contact person identifier, which is the person identifier from the Oracle Sales Cloud Partner object. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyMembers-MemberReferrals-item-patch-request
Type:
Show Source
object
-
AccntId: integer
(int64)
Title:
Account ID
The account identifier for the member's partner object of the member referred by current member. If the MemberType attribute is set to Company, then Oracle Loyalty Cloud populates AccountId. This attribute depends on the value of the MemberType attribute. There is no default value or limitation with this attribute. -
AccrualStartDate: string
(date-time)
Title:
Accrual Start Date
The date when the member starts accruing points from another member. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
AccrualToHouseholdFlag: string
Title:
Accrual to Household
This flag determines whether the accrual due to a transaction completed by a household member should be accrued to a member or to the household to which it belongs. There is no default value associated with this attribute. -
AccrualToMemId: integer
(int64)
Title:
Accrual-to Member ID
The identifier of the member to whose account the points are accrued for a corporate accrual. This attribute shows information about the referred member. This attribute value depends on the AccrualType attribute. There is no default value or limitation associated with this attribute. -
AccrualTypeCode: string
Title:
Accrual Type
Maximum Length:30
The accrual type value, that is an LOV attribute which is based on FND lookups. This attribute shows information about the referred member. For the possible input values of AccrualTypeCode, the integrating user must first invoke the corresponding LOV resource path URL. For example: invoke lovResourcepath ../crmRestApi/resources/11.12.0.0/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_ACCRU_TYPE. There is no default value, dependency, or limitation associated with this attribute. -
ContactId: integer
(int64)
Title:
Contact ID
The contact identifier as specified in the Member Contacts object. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactName: string
Title:
Contact
Maximum Length:450
The name of the contact associated with the member. This attribute shows information about the referred member. This attribute has the format of ContactFirstName ContactLastName. There is no default value, dependency, or limitation associated with this attribute. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The currency code used by the corporation. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CorpMemberNumber: string
Title:
Corporation Member Number
Maximum Length:15
The corporate member number. If the current member is part of the company or corporate account, then Oracle Loyalty Cloud populates this field. This is an optional attribute which is introduced for future use. Oracle Loyalty Cloud does not currently use this attribute. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CreationSource: string
Title:
Creation Source
The information detailing the member creation source. This attribute value is set while creating a member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate method that is applied. This rate can apply to an individual or throughout the corporation. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The international currency code used by the loyalty member to complete transactions. International codes such as USD, INR,GBP are valid for this attribute. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyDate: string
(date)
Title:
Currency Date
The date when the currency conversion rate is applied for a given currency code. There is no default value, dependency, or limitation associated with this attribute. -
HouseholdMemberNumber: string
Title:
Household Member Number
The member number of a household to be passed by a payload. This value should be a valid household enrolled already in the same loyalty program. There is no default value associated with this attribute. -
JobTitle: string
Title:
Job Title
The job title of a contact which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
LastAccrTransactionDt: string
(date-time)
Title:
Last Accrual Transaction Date
The date when the last accrual transaction for the loyalty member has occurred. There is no default value, dependency, or limitation associated with this attribute. -
LastRdmTransactionDt: string
(date-time)
Title:
Last Redemption Transaction Date
The last redemption transaction date. This attribute shows when the last redemption transaction by the member has occurred. There is no default value, dependency, or limitation associated with this attribute. -
LastTransactionProcedDt: string
(date-time)
Title:
Last Transaction Processed Date
The last transaction process date. This date shows when the last transaction was performed by the loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeAVal: number
Title:
Lifetime Payment Type A Value
The member's life time point balance in internal point type A. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeBVal: number
Title:
Lifetime Payment Type B Value
The member's life time point balance in internal point type B. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeCVal: number
Title:
Lifetime Payment Type C Value
The member's life time point balance in internal point type C. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeDVal: number
Title:
Lifetime Payment Type D Value
The member's life time point balance in internal point type D. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeEVal: number
Title:
Lifetime Payment Type E Value
The member's life time point balance in internal point type E. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeFVal: number
Title:
Lifetime Payment Type F Value
The member's life time point balance in internal point type F. A program can have up to eight point types, internally referred to as Point type (A to H). Each of the point type has a life time point balance associated with it which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeGVal: number
Title:
Lifetime Payment Type G Value
The member's life time point balance in internal point type G. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeHVal: number
Title:
Lifetime Payment Type H Value
The member's life time point balance in internal point type H. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LoyAccountName: string
Title:
Account Name
The loyalty member account name for the member's partner object. If the MemberTypeCode attribute is Company, then Oracle Loyalty Cloud populates the account name. This attribute depends on the value of the MemberTypeCode attribute. Oracle Loyalty Cloud populates the AccountName attribute based on the AccountId attribute. There is no default value or limitation associated with this attribute. -
LoyHouseholdName: string
Title:
Household Name
The household member name. If the MemberTypeCode attribute is set to Household, then this attribute shows membership information about the referred household. There is no default value, dependency, or limitation associated with this attribute. -
LoyMemberId: integer
(int64)
Title:
Loyalty Member ID
The primary key of member referred by current loyMember resource. There is no default value, dependency, or limitation associated with this attribute. -
LstTierChangeDt: string
(date-time)
Title:
Date of Member's Last Tier Change
The date when the member's tier change occurs. Oracle Loyalty Cloud updates this date when a member's tier changes. There is no default value, dependency, or limitation associated with this attribute. -
MemberClassCode: string
Title:
Member Class
Maximum Length:30
The FND lookup code value of Member Class as an input of loyalty Members. The possible input values can be obtained by invoking the corresponding lovResourcePath URL: fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_CLASS. -
MemberGrpCode: string
Title:
Member Group
Maximum Length:30
The extended Lookup Type attribute of type ORA_LOY_MEM_GRP which shows information about the member's current group. There is no default value, dependency, or limitation associated with this attribute. -
MemberName: string
Title:
Member Name
Maximum Length:100
The name of the referred loyalty member, which can be provided as input while creating a loyalty member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
MemberPhaseCode: string
Title:
Member Phase
Maximum Length:30
The lookup code value of the member phase used as a an input for loyalty Members. The integrating user must first invoke the lovResourcepath URL for possible input values. The corresponding lovResourcePath URL is ?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_PHASE. There is no default value, dependency, or limitation associated with this attribute. -
MembershipSchemeId: integer
(int64)
Title:
Membership Scheme ID
The unique reference to the member scheme, if any, chosen by the user while enrolling into the loyalty program. The member scheme can be a paid or free scheme. For example, a 6 months free membership, or a 1 Year $5 paid membership, and so on. There is no default value, dependency, or limitation associated with this attribute. -
MemberTypeCode: string
Title:
Type
Maximum Length:30
Default Value:ORA_MEM_TYPE_INDIVIDUAL
The member type, which is provided as an input attribute while creating a loyalty member. To know the possible input values, the user must invoke the corresponding lovResourcePath URL ....fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_TYPE. There is no default value, dependency, or limitation associated with this attribute. -
OrgGroupId: integer
(int64)
Title:
Organization Group ID
The organization group identifier to which the loyalty member belongs. There is no default value, dependency, or limitation associated with this attribute. -
ParentMember: string
Title:
Parent
Maximum Length:1
Default Value:N
The parent member where the loyalty member is either a household or an individual, but is also a corporate member. There is no default value, dependency, or limitation associated with this attribute. -
PartyName: string
Title:
Contact Party Name
Maximum Length:360
The loyalty partner name as an alternative identifier. Oracle Loyalty Cloud creates this identifier when a loyalty membership is created through a partner as a reference. There is no default value, dependency, or limitation associated with this attribute. -
PersonName: string
Title:
Person Name
Maximum Length:450
The full name of the member contact. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same LastName attribute can be used while enrolling a member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeAVal: number
Title:
Point Type A Value
Default Value:0
The points for the member from Point Type A as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeBVal: number
Title:
Point Type B Value
Default Value:0
The points for the member from Point Type B as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeCVal: number
Title:
Point Type C Value
Default Value:0
The points for the member from Point Type C as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeDVal: number
Title:
Point Type D Value
Default Value:0
The points for the member from Point Type D as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeEVal: number
Title:
Point Type E Value
Default Value:0
The points for the member from Point Type E as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeFVal: number
Title:
Point Type F Value
Default Value:0
The points for the member from Point Type F as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeGVal: number
Title:
Point Type G Value
Default Value:0
The points for the member from Point Type G as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeHVal: number
Title:
Point Type H Value
Default Value:0
The points for the member from Point Type H as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PrConId: integer
(int64)
Title:
Primary Contact ID
The partner contact identifier. This value can be provided as an input while creating a loyalty member through the resource and when Oracle Loyalty Cloud enrols the corresponding contact as a member in the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
RealTimeBonusFlag: boolean
Title:
Real Time Bonus
Maximum Length:1
Default Value:false
The real time bonus flag. If this flag is set to Y, then on member enrollment, it processes enrollment and referral bonus transactions in real time. Otherwise, it will create an enrollment bonus and referral bonus transaction and set the status to Queued for the batch engine to pick and process. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByNam: string
Title:
Referred By
Maximum Length:100
The member identifier of the referring member name who has referred the current member to the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByName: string
Title:
Referred By
The member identifier by name who has referred the current member to the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByNumber: string
Title:
Referred by Number
Maximum Length:30
The member number of the member who has referred the current member to the loyalty program. This value is input by the user and is validated against the existing member record in Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
RelationshipId: integer
(int64)
Title:
Relationship ID
The relationship identifier which shows the relationship between loyalty members. There is no default value, dependency, or limitation associated with this attribute. -
reltype: string
Title:
Relationship Type
The relationship type showing the type of relation between loyalty members. For example, there might be a relationship between an organization and a member. There is no default value, dependency, or limitation associated with this attribute. -
StartDate: string
(date-time)
Title:
Joining Date
The date when the membership in the loyalty program starts. There is no default value, dependency, or limitation associated with this attribute. -
Status: string
Title:
Status Meaning
Maximum Length:80
The member status meaning of referred loyalty member which is a read-only value based on the Status code attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_STATUS lookup. There is no default value or limitation associated with this attribute. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:ORA_MEM_STATUS_ACTIVE
The status code of the loyalty member, which is a read-only value based on the Status attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_STATUS lookup. There is no default value or limitation associated with this attribute. -
SuppressCall: string
Title:
Suppress Call
The attribute indicates that the member does not want to receive any calls pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressCallFlag: boolean
Title:
Block Member Call Contact
Maximum Length:1
Default Value:false
Block Member Call Contact. -
SuppressEmail: string
Title:
Suppress Email
The attribute indicates that the member does not want to receive any mail pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressEmailFlag: boolean
Title:
Block Member Email Contact
Maximum Length:1
Default Value:false
Block Member Email Contact. -
SuppressFax: string
Title:
Suppress Fax
The attribute indicates that the member does not want to receive any fax pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressFaxFlag: boolean
Title:
Block Member Fax Contact
Maximum Length:1
Default Value:false
Block Member Fax Contact. -
SuppressMail: string
Title:
Suppress Mail
The attribute indicates that the member does not want to receive any mail pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressMailFlag: boolean
Title:
Block Member Mail Contact
Maximum Length:1
Default Value:false
Block Member Mail Contact. -
SuppressSMS: string
Title:
Suppress SMS
The attribute indicates that the member does not want to receive any SMS pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressSMSFlag: boolean
Title:
Block Member SMS Contact
Maximum Length:1
Default Value:false
Block Member SMS Contact. -
URL: string
The member URL which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute.
-
ValLifeScore: string
Title:
Lifetime Value Score
Maximum Length:50
The life time value score of the loyalty member as the highest watermark value. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyMembers-MemberTier-item-patch-request
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
The Active flag represents whether the tier which is active among all the member tier records. For example a member might be promoted from a silver to gold tier. There will be two records, one for silver and another for gold but the record with gold tier is marked as active which means the member currently belongs to the gold tier. The default value is N, but there is no dependency, or limitation associated with this attribute. -
Comments: string
Title:
Reason for Change
Maximum Length:250
The comments provided by the Loyalty Engine while changing the member tier. There is no default value, dependency, or limitation associated with this attribute. -
EndDt: string
(date-time)
Title:
End Date
The date when the member tier ends. The loyalty member is active in a particular member tier until this date. There is no default value, dependency, or limitation associated with this attribute. -
FromTierStartDate: string
(date)
Title:
From Tier Start Date
The tier start date of the current tier. There is no default value, dependency, or limitation associated with this attribute. -
FutrTierStampDt: string
(date)
Title:
Future Tier Date
The Stamp Future Tier attribute flags the future tier assessment date details if it is likely that a member will be downgraded or requalified based on the Tier Effective Period End Date. There is no default value, dependency, or limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member ID
The member reference identifier for the current member tier child records, which provides information about the current member tier to which the member belongs. There is no default value, dependency, or limitation associated with this attribute. -
MemTierId: integer
(int64)
Title:
Member Tier ID
The member tier identifier, which is an internal identifier for the member tier for which the member tier record exists. For example, if the member has a current tier of Silver, then the record in the Member Tier object has an entry for MemberId with MemberTierid as the unique identifier. There is no default value, dependency, or limitation associated with this attribute. -
NextAssessDt: string
(date)
Title:
Next Tier Assessment Date
The date on which the next tier assessment occurs for the member. There is no default value, dependency, or limitation associated with this attribute. -
OrigEndDt: string
(date-time)
Title:
Original Tier End Date
The system-generated tier end date for the tier record. There is no default value, dependency, or limitation associated with this attribute. -
OverrideDt: string
(date)
Title:
Override Date
The date on which a tier change occurs and overrides the tier end date. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeAVal: number
Title:
Point Type A Value
The points for the member from Point Type A as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeBVal: number
Title:
Point Type B Value
The points for the member from Point Type B as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeCVal: number
Title:
Point Type C Value
The points for the member from Point Type C as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeDVal: number
Title:
Point Type D Value
The points for the member from Point Type D as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeEVal: number
Title:
Point Type E Value
The points for the member from Point Type E as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeFVal: number
Title:
Point Type F Value
The points for the member from Point Type F as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeGVal: number
Title:
Point Type G Value
The points for the member from Point Type G as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeHVal: number
Title:
Point Type H Value
The points for the member from Point Type H as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
ProcessedDt: string
(date)
Title:
Processed Date
The date when the member tier is processed. When the Oracle Loyalty Cloud engine initiates tier processing, it sets the date when it updates the tier. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingComment: string
Title:
Processing Comment
Maximum Length:1000
The tier processing comment that provides the details of an error, if any occurred, during tier processing. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingLog: string
Title:
Processing Log
Maximum Length:1000
The tier processing log that provides the details of all the promotions that are applied. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingStatCode: string
Title:
Processing Status
Maximum Length:30
The tier processing status code that provides the details of all the promotions that are applied. There is no default value, dependency, or limitation associated with this attribute. -
QualEndDate: string
(date-time)
Title:
Qualifying End Date
The qualifying end date of the member tier. There is no default value, dependency, or limitation associated with this attribute. -
QualFlag: boolean
Title:
Qualifying
Maximum Length:1
The flag that indicates the points are of type qualifying points. There is no default value, dependency, or limitation associated with this attribute. -
QualStartDate: string
(date-time)
Title:
Qualifying Start Date
The qualifying start date of the member tier. There is no default value, dependency, or limitation associated with this attribute. -
ReasonValue: string
Title:
Reason for Change Meaning
Maximum Length:80
The reason for the change of the member tier. The attribute gets its value when the Oracle Loyally Cloud engine initiates the tier processing. This attribute shows the reason why particular loyalty members get their tiers changed. There is no default value, dependency, or limitation associated with this attribute. -
StartDt: string
(date-time)
Title:
Start Date
The date when the member tier starts. For example, if the loyalty member's current tier is Silver and previously the tier was Bronze, then the Bronze tier has a start date and an end date which signifies the time period that the loyalty member belonged to that particular tier. There is no default value, dependency, or limitation associated with this attribute. -
TierClassId: integer
(int64)
Title:
Tier Class ID
The tier class identifier of a member tier, which is a reference identifier that uniquely identifies a member tier class. It provides information about which tier class the current member tier record belongs. There is no default value, dependency, or limitation associated with this attribute. -
TierId: integer
(int64)
Title:
Tier ID
The tier identifier of the member tier which is the unique identifier to identify a loyalty tier. For example, if a member currently belongs to the Silver tier, then to identify the Silver tier, Oracle Loyalty Cloud uses the LoyTierId attribute as an internal Identifier. There is no default value, dependency, or limitation associated with this attribute. -
TierName: string
Title:
Tier
Maximum Length:30
The tier name to which the member currently belongs. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyMembers-MemberTransactions-item-patch-request
Type:
Show Source
object
-
AccrualDisputeStatusCode: string
Title:
Accrual Dispute Status
Maximum Length:30
The attribute specifies the status of the created accrual dispute, that is, whether the accrual dispute created is approved or rejected. The accepted values are ORA_ACRL_DISPUTE_STAT_APPR and ORA_ACRL_DISPUTE_STAT_REJ. There is no default value, dependency, or limitation associated with this attribute. -
ActivityDate: string
(date-time)
Title:
Activity Date
The date when a transaction activity occurs. The transaction can be an accrual or redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
ActivityDay: number
Title:
Activity Day
The transaction activity day. This attribute represents the day when an accrual or redemption activity occurs. There is no default value, dependency, or limitation associated with this attribute. -
ActivityHour: number
Title:
Activity Hour
The transaction activity hour. This attribute represents the time in hours when an accrual or redemption activity occurs. There is no default value, dependency, or limitation associated with this attribute. -
AdjustedListPrice: number
Title:
Adjusted List Price
The attribute is a currency that displays the redemption price that is used during redemption. There is no default value, dependency, nor limitation associated with this attribute. -
AmountValue: number
Title:
Amount
The total amount spent on the accrual or redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
ApproveDt: string
(date-time)
Title:
Approve Date
The transaction approval date. If the transaction involves an approval process, then the identifier indicates the date when the transaction is approved by the reviewer. There is no default value, dependency, or limitation associated with this attribute. -
BookClassCode: string
Title:
Booking Class
Maximum Length:30
The booking class code. This attribute specifies the class of the airline ticket. The accepted values are ORA_TRAVL_BOOK_BUSI or ORA_TRAVL_BOOK_ECO. There is no default value, dependency, or limitation associated with this attribute. -
BookingDt: string
(date-time)
Title:
Booking Date
The transaction booking date. If the transaction is an airline transaction, then this attribute indicates the date when the booking is made for travel. There is no default value, dependency, or limitation associated with this attribute. -
CancelledTransactionId: integer
(int64)
Title:
Canceled Transaction
The canceled transaction identifier. This attribute is the primary key of the transaction that is canceled. There is no default value, dependency, or limitation associated with this attribute. -
CancReasonCode: string
Title:
Cancellation Reason Code
Maximum Length:30
The cancellation reason code. This attribute value represents the reason why the transaction is canceled. There is no default value, dependency, or limitation associated with this attribute. -
ChildTransactionId: integer
(int64)
Title:
Child Transaction ID
The child transaction identifier. This attribute is the primary key of the transaction, that is, the child of the current transaction. There is no default value, dependency, or limitation associated with this attribute. -
Comments: string
Title:
Comments
Maximum Length:250
The transaction comments. This attribute stores the comments entered by the user, if any, for future reference. There is no default value, dependency, or limitation associated with this attribute. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The currency code used by the corporation. There is no default value, dependency, or limitation associated with this attribute. -
CorporateReferenceNumber: string
Title:
Company Reference Number
Maximum Length:30
The reference to a third-party corporate member from the program to get the points allocated between the individual and the corporation or company, if an individual member completes a transaction on behalf of the corporation or company. There is no default value, dependency, or limitation associated with this attribute. -
CorpRefMemberId: integer
(int64)
Title:
Loyalty Member ID
The corporate reference member identifier. There is no default value, dependency, nor limitation associated with this attribute. -
CorpRefName: string
Title:
Company Reference
Maximum Length:100
The corporate reference member name. If the current member is part of the company or corporate account, then Oracle Loyalty Cloud populates this field. This is an optional attribute which is populated only when the transaction is done by an individual member on behalf of a company. There is no default value, dependency, or limitation associated with this attribute. -
CurcyCode: string
Title:
Currency Code
Maximum Length:20
The transaction currency code. This attribute indicates the currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value or dependency associated with this attribute. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate method that is applied for the transaction. There is no default value, dependency, or limitation associated with this attribute. -
CurcyExchDt: string
(date-time)
Title:
Currency Exchange Date
The date when the currency exchange occurs during the creation of a transaction. There is no default value, dependency, or limitation associated with this attribute. -
Description: string
Title:
Product
The attribute indicates the description of the product that would be accrued or redeemed in the transaction. There is no default value, dependency, or limitation associated with this attribute. -
DestAirportCode: string
Title:
Destination Airport
Maximum Length:30
The destination airport code. This attribute value is a code representing the airport where the flight arrives when reaching its destination. The accepted values are ORA_AIRPORT_BOM, ORA_AIRPORT_BOS, or ORA_AIRPORT_SFO. There is no default value, dependency, or limitation associated with this attribute. -
DestCityCode: string
Title:
Destination City
Maximum Length:30
The destination city code. The attribute value represents the city where the flight arrives when it reaches its destination. There is no default value, dependency, or limitation associated with this attribute. -
DestZoneCode: string
Title:
Destination Zone
Maximum Length:30
The zone where the flight arrives when it reaches its destination. The list of possible values are ORA_AIRLINE_ZONE_ASIA, ORA_AIRLINE_ZONE_EUROPE, or ORA_AIRLINE_ZONE_NAMER. There is no default value, dependency, or limitation associated with this attribute. -
DocumentNumber: string
Title:
Document Number
Maximum Length:30
The document number associated with the transaction. This attribute provides additional information in the transaction for the retail industry. There is no default value, dependency, or limitation associated with this attribute. -
EndDt: string
(date-time)
Title:
End Date
The transaction end date. This attribute is the date when the transaction is no longer in effect. This attribute value, if provided, must be set to a value after the StartDt attribute. There is no default value or dependency associated with this attribute. -
EventName: string
Title:
Event Name
Maximum Length:75
The event name associated with the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
ExpireInDays: number
Title:
Expires in Days
The date when the accrued points will expire, in days. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductLine: string
Title:
Product Line - External
Maximum Length:30
The product line associated with the product for the transaction that is from an external source. The accepted value is ORA_EXT_PROD_LINE_CG. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductName: string
Title:
Product Name - External
Maximum Length:240
The product name reference in the external system. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductType: string
Title:
Product Type - External
Maximum Length:30
The type of products coming into the Oracle Loyalty Cloud system from an external source. The accepted value is ORA_EXT_PROD_TYPE_ELEC. There is no default value, dependency, or limitation associated with this attribute. -
ExternalReservationNumber: string
Title:
External Reservation Number
Maximum Length:250
The external reservation number, specific to the airline industry, where a reservation is performed by an agent and has different reservation numbers. There is no default value, dependency, or limitation associated with this attribute. -
ExternalTransaction: string
Title:
External
Maximum Length:1
Default Value:N
The details of the transaction coming from a partner???s external application into loyalty when loyalty is integrated with a third-party application. There is no default value, dependency, or limitation associated with this attribute. -
FareBasis: string
Title:
Fare Basis
Maximum Length:30
The transaction fare basis. This attribute is a code that represents the fare basis on which the ticket fare is based. The accepted values are ORA_FARE_BASIS_BUSI or ORA_FARE_BASIS_ECO. There is no default value, dependency, or limitation associated with this attribute. -
FareBasisCode: string
Title:
Fare Basis Code
Maximum Length:30
The transaction fare basis code. This attribute is a code that represents the fare basis on which the ticket fare is based. The accepted values are ORA_FARE_BASIS_BUSI or ORA_FARE_BASIS_ECO. There is no default value, dependency, or limitation associated with this attribute. -
FareTypeCode: string
Title:
Fare Type
Maximum Length:30
The fare type code. This attribute is a code value that determines the class of the flight travel. The accepted values are ORA_FARE_BUSN_CLASS or ORA_FARE_FIRST_CLASS. There is no default value, dependency, or limitation associated with this attribute. -
FlightNumber: string
Title:
Flight Number
Maximum Length:30
The transaction flight number. If the transaction pertains to airlines, then this attribute indicates the flight number where the travel takes place. This attribute is input by the user during transaction creation. There is no default value, dependency, or limitation associated with this attribute. -
FltTypeCode: string
Title:
Flight Type Code
Maximum Length:30
The attribute specifies the flight type, for example, Boeing or Airbus. There is no default value, dependency, or limitation associated with this attribute. -
GdsRecLocator: string
Title:
GDS Record Locator
Maximum Length:30
The global distribution system (GDS) record locator. There is no default value, dependency, or limitation associated with this attribute. -
IncentivChoice: string
Title:
Incentive Choice
Maximum Length:30
The incentives or rewards that a member receives for enrolling into a promotion. There is no default value, dependency, or limitation associated with this attribute. -
IntegrationId: string
Title:
Integration ID
Maximum Length:30
The integration identifier of the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
InternalDest: string
Title:
Internal Destination
Maximum Length:15
The details of the destination that is used internally by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
InternalFlightDt: string
(date-time)
Title:
Internal Flight Date
The local date for the flight for the country. For example, 24/01/2018 is equal to GMT +5.30 in India. There is no default value, dependency, or limitation associated with this attribute. -
InternalOrigin: string
Title:
Internal Origin
Maximum Length:15
The flight origin details that are local to the region. There is no default value, dependency, or limitation associated with this attribute. -
InvOrgId: integer
(int64)
Title:
Inventory Organization ID
The organization from where inventory is being picked. For example, when a transaction is created, sometimes the inventory or goods are picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is being picked from a different organization. There is no default value, dependency, or limitation associated with this attribute. -
ItemNumber: string
Title:
Item Number
Maximum Length:30
The transaction item number that is used during the creation of a transaction. There is no default value, dependency, or limitation associated with this attribute. -
LineItemNumber: integer
(int64)
Title:
Line Item Number
The line item number for a multiple line item order transaction. There is no default value, dependency, or limitation associated with this attribute. -
LoanBalance: number
Title:
Loan Balance
The remaining balance of the loan that you can use when creating a transaction. There is no default value, dependency, or limitation associated with this attribute. -
LoanRepaymentDt: string
(date-time)
Title:
Loan Repayment Date
The date which specifies when the loan is repaid. There is no default value, dependency, or limitation associated with this attribute. -
LocationName: string
Title:
Location Name
Maximum Length:30
The attribute is text that used in the retail industry for giving promotions. For example, for the same retailer, the promotion is applied only if the store is located in India. If the store is located outside India, then no promotions are applied. There is no default value, dependency, or limitation associated with this attribute. -
MarketingFlightNumber: string
Title:
Marketing Flight Number
Maximum Length:30
The marketing flight number, which is specific to the airline industry and which indicates the flight number used in the airline's marketing campaign. There is no default value, dependency, or limitation associated with this attribute. -
OperFltNum: string
Title:
Operating Flight Number
Maximum Length:30
The operating flight number used in the airline transactions. There is no default value, dependency, nor limitation associated with this attribute. -
OptyCost: number
Title:
Opportunity Cost
The transaction opportunity cost associated with the transaction. There is no default value, dependency, or limitation associated with this attribute. -
OrderNumber: string
Title:
Order Number
Maximum Length:30
The number associated with an order. This attribute is used by Oracle Loyalty Cloud when consolidating transactions. There is no default value, dependency, or limitation associated with this attribute. -
OrderQuantity: number
Title:
Order Quantity
The transaction order quantity. This attribute indicates the number of points for which an order was placed. There is no default value, dependency, nor limitation associated with this attribute. -
OrganizationCode: string
Title:
Organization
Maximum Length:18
The organization code associated with the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
OrigAirportCode: string
Title:
Origin Airport
Maximum Length:30
The origin airport code. This attribute value represents the airport from where the flight departs. There is no default value, dependency, or limitation associated with this attribute. -
OrigAmount: number
Title:
Original Amount
The attribute specifies the total amount without any discount, and so on, being applied in the transaction. There is no default value, dependency, nor limitation associated with this attribute. -
OriginCityCode: string
Title:
Origin City Code
Maximum Length:30
The origin city code. This attribute value represents the city from where the flight departs. There is no default value, dependency, or limitation associated with this attribute. -
OrigOrderId: integer
(int64)
Title:
Original Order ID
The attribute indicates the original order identifier that led to the creation of these transactions. There is no default value, dependency, or limitation associated with this attribute. -
OrigOrdItmId: integer
(int64)
Title:
Original Order Line Item
The details of the order item that is originally placed, which is especially used for exchanges, and so on, in retail transactions. There is no default value, dependency, or limitation associated with this attribute. -
OrigPoints: number
Title:
Original Point
The original value of the transaction in points without any subsequent bonus added by each promotion. There is no default value, dependency, or limitation associated with this attribute. -
OrigZoneCode: string
Title:
Origin Zone
Maximum Length:30
The code representing the zone from where the flight departs. Possible values are ORA_AIRLINE_ZONE_ASIA, ORA_AIRLINE_ZONE_EUROPE, or ORA_AIRLINE_ZONE_NAMER. There is no default value, dependency, or limitation associated with this attribute. -
OvrDupCheck: string
Title:
Duplicate Check Overridden
Maximum Length:1
Default Value:N
The flag that indicates whether duplicate line items are allowed in a transaction or not. There is no default value, dependency, or limitation associated with this attribute. -
OwnerId: integer
(int64)
Title:
Owner ID
The user that created the transaction and that owns the transaction. There is no default value, dependency, or limitation associated with this attribute. -
PackageCode: string
Title:
Package Code
Maximum Length:30
The transaction package code. This attribute identifies the package from which line items are picked. There is no default value, dependency, or limitation associated with this attribute. -
ParentTransactionId: integer
(int64)
Title:
Partner Transaction ID
The transaction identifier for the parent transaction that creates the current transaction. There is no default value, dependency, or limitation associated with this attribute. -
PartitionName: string
Title:
Partition Name
Maximum Length:30
The transaction partition name. There is no default value, dependency, or limitation associated with this attribute. -
PartnerNumber: string
Title:
Partner Number
The partner number attribute is a unique identifier from HZ_PARTIES that gives partner details for whom the transaction is being created. There is no default value, dependency, or limitation associated with this attribute. -
PeriodDurCode: string
Title:
Period Duration
Maximum Length:30
The period duration code that specifies the duration in days, or months, and so on. There is no default value, dependency, or limitation associated with this attribute. -
PeriodTypeCode: string
Title:
Period Type
Maximum Length:30
The period type code. Period type options are Months, Years, Lifetime, and so on. There is no default value, dependency, or limitation associated with this attribute. -
PnrName: string
Title:
PNR Name
Maximum Length:50
The transaction passenger name record (PNR) name. There is no default value, dependency, or limitation associated with this attribute. -
PnrNumber: string
Title:
PNR Number
Maximum Length:50
The transaction passenger name record (PNR) number. There is no default value, dependency, or limitation associated with this attribute. -
Points: number
Title:
Base Points
The attribute indicates the number of points that would be transferred for a TransferPoints redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeName: string
Title:
Point Type Name
The point type name. This attribute is dependent on the Program Name Identifier. There is no default value or limitation associated with this attribute. -
PostDt: string
(date-time)
Title:
Post Date
The date when the transaction is posted. There is no default value, dependency, or limitation associated with this attribute. -
PriceOverriden: string
Title:
Price Overridden
Maximum Length:1
Default Value:N
The flag that indicates whether the price must be overridden or not. There is no default value, dependency, or limitation associated with this attribute. -
ProcessDt: string
(date-time)
Title:
Processed Date
The transaction process date. This attribute specifies the day when the created transaction is processed. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingComment: string
Title:
Processing Information
Maximum Length:1000
The transaction processing comment that provides the details of an error, if any occurred, during transaction processing. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingLog: string
Title:
Processing Log
Maximum Length:1000
The transaction processing log that provides the details of all the promotions that are applied, all the points that are assigned, and all the vouchers that are assigned, if any. There is no default value, dependency, or limitation associated with this attribute. -
ProdId: integer
(int64)
Title:
Product ID
The product identifier of the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
ProductNumber: string
Title:
Product Number
The product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute. -
PtnrProcDt: string
(date-time)
Title:
Partner Processing Date
The date on which the transaction is processed at the partner end. There is no default value, dependency, or limitation associated with this attribute. -
PtnrStatusCode: string
Title:
Partner Status Code
Maximum Length:30
The status code used by the partner on processing the transaction. There is no default value, dependency, or limitation associated with this attribute. -
PymtTypeCode: string
Title:
Payment Type
Maximum Length:30
The payment type code specifies how the payment is made for the transaction. There is no default value, dependency, or limitation associated with this attribute. -
QualifyingPointUsed: string
Title:
Qualifying
Maximum Length:1
Default Value:N
The qualifying point used. These qualifying points count towards a member???s tier status. There is no default value, dependency, or limitation associated with this attribute. -
QueuedProcessingFlag: boolean
Title:
Queued Processing
Maximum Length:1
Default Value:false
The flag, which if set to true in the input payload, then the transaction status is set to queue without processing it. There is no default value or limitation associated with this attribute. -
ReasonCode: string
Title:
Reason Code
Maximum Length:30
The reason for the cancellation or refund, if the transaction is cancelled. For example, a fee that is inadvertently applied. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionQuantity: number
Title:
Redemption Quantity
The quantity that would be redeemed in a redemption transaction. There is no default value, dependency, nor limitation associated with this attribute. -
RedemptionQuantityUOMCode: string
Title:
Unit of Measure for the Redemption Quantity
Maximum Length:30
The redemption products quantity unit of measure (UOM) code. For example, possible UOM codes are kilograms or litres. There is no default value, dependency, or limitation associated with this attribute. -
RefundPct: number
Title:
Refund Percentage
The percentage of the refund that is granted in the transaction. There is no default value, dependency, or limitation associated with this attribute. -
RfndOvrdCmnts: string
Title:
Refund Override Comments
Maximum Length:250
The refund override comments in the event a refund is made. There is no default value, dependency, or limitation associated with this attribute. -
RfndOvrdRsnCode: string
Title:
Refund Override Reason
Maximum Length:30
The refund override reason code in the event a refund is made. There is no default value, dependency, or limitation associated with this attribute. -
SmActionTypeCode: string
Title:
Social Action Type
Maximum Length:30
The code that provides the social media action type. The accepted values are ORA_SOCIAL_ACTION_CHECK_IN, ORA_SOCIAL_ACTION_RATE, or ORA_SOCIAL_ACTION_SHARE. There is no default value, dependency, or limitation associated with this attribute. -
SourceCode: string
Title:
Source
Maximum Length:30
The code that represents the source of the transaction. The possible values are ORA_TXN_SOURCE_WEB, ORA_TXN_SOURCE_MOBILE, or ORA_TXN_SOURCE_BILL. There is no default value, dependency, or limitation associated with this attribute. -
StartDt: string
(date-time)
Title:
Start Date
The transaction start date. Either Oracle Loyalty Cloud generates this attribute value when a new transaction is created and populates the attribute with the current date, or it is entered by the user when creating the transaction using the resource. There is no default value, dependency, or limitation associated with this attribute. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:ORA_TXN_STAT_IN_PROG
The current state of the transaction. The accepted values are ORA_TXN_STAT_IN_PROG, ORA_TXN_STAT_REJ, or ORA_TXN_STAT_PROCESSED. There is no default value, dependency, or limitation associated with this attribute. -
SubmitDt: string
(date-time)
Title:
Submit Date
The transaction submission date. Oracle Loyalty Cloud assigns this attribute value when the transaction is submitted for approval by changing the Transaction Status attribute value to Submitted. There is no default value, dependency, or limitation associated with this attribute. -
SubStatusCode: string
Title:
Processing Sub Status
Maximum Length:30
The code that specifies the status of the transaction processing, for example, whether there is an error or the transaction is successful, and so on. The accepted values are ORA_TXN_SUB_STAT_ERROR, ORA_TXN_SUB_STAT_SUCCESS, or ORA_TXN_SUB_STAT_NO_PROMO_QF. There is no default value, dependency, or limitation associated with this attribute. -
TaxAmount: number
Title:
Tax Amount
The attribute indicates the tax that should be paid for the transaction after it is completed. There is no default value, dependency, nor limitation associated with this attribute. -
TicketNumber: string
Title:
Ticket Number
Maximum Length:30
The unique number that is used to identify the ticket booking for an airline transaction. There is no default value, dependency, or limitation associated with this attribute. -
ToMemberNumber: string
Title:
To Member
Maximum Length:30
The unique identification number of the member to whom points are transferred. There is no default value, dependency, or limitation associated with this attribute. -
TotalDays: integer
(int64)
Title:
Days
The total days that are required for travel between the source and destination locations. There is no default value, dependency, or limitation associated with this attribute. -
TotalLines: number
Title:
Total Lines
The total line items for the transaction. A transaction can include many order line items. There is no default value, dependency, or limitation associated with this attribute. -
TransactionChannelCode: string
Title:
Channel
Maximum Length:30
The code that indicates how the transaction is created. The accepted values are ORA_TXN_CHANNEL_MOBILE, ORA_TXN_CHANNEL_WEB, or ORA_TXN_CHANNEL_TELE. There is no default value, dependency, or limitation associated with this attribute. -
TransactionDate: string
(date-time)
Title:
Transaction Date
The date when the transaction is completed. There is no default value, dependency, or limitation associated with this attribute. -
TransactionSourceCode: string
Title:
Transaction Source Code
Maximum Length:30
The transaction source code attribute indicates the transaction activity type like Airlines, Hotels, Car Rental, and so on. There is no default value, dependency, or limitation associated with this attribute. -
TransferPoints: number
Title:
Transfer Points
The attribute indicates the number of points that would be transferred in a TransferPoints redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
TrvClassCode: string
Title:
Travel Class
Maximum Length:30
The code that indicates the class in which the passenger is traveling. The accepted values are ORA_TRAVL_CLASS_BUSI or ORA_TRAVL_CLASS_ECO. There is no default value, dependency, or limitation associated with this attribute. -
TrvlDistance: number
Title:
Distance
The transaction travel distance. This attribute stores the total miles travelled. There is no default value, dependency, or limitation associated with this attribute. -
UnaccMinor: string
Title:
Unaccounted Minor
Maximum Length:1
Default Value:N
The unaccounted transaction for a minor, that is below the age of majority. There is no default value, dependency, or limitation associated with this attribute. -
ValStatusCode: string
Title:
Value Status Code
Maximum Length:30
The status of the validation performed on the record. There is no default value, dependency, or limitation associated with this attribute. -
VoucherNumber: string
Title:
Voucher Number
The alternative way to identify a member voucher. The UI shows the voucher number but the VoucherNumber attribute is used in the URI to update a voucher record using the resource. The VoucherNumber attribute can also be used as a parameter for the validateVoucherFinder finder. There is no default value, dependency, or limitation associated with this attribute. -
VoucherQuantity: number
Title:
Voucher Quantity
The attribute provides details of how many vouchers are assigned because of the given transaction after processing. There is no default value, dependency, nor limitation associated with this attribute.
Nested Schema : loyMembers-pointItems-item-patch-request
Type:
Show Source
object
-
AccrualedValue: number
Title:
Number of Points
The points accrued value for the points that are accrued by the member. There is no default value, dependency, or limitation associated with this attribute. -
AccrualEffDt: string
(date-time)
Title:
Accrual Start Date
Displays the date from which the points would be effective, that is, the date when the points are available for redemption. Point items having a future effective date will fall under the 'Future Points' category and would move under 'Available Points' once the effectivity date is reached. There is no default value, dependency, or limitation associated with this attribute. -
ExpirationDt: string
(date-time)
Title:
Expiration Date
The date when the points that have accrued expire. There is no default value, dependency, or limitation associated with this attribute. -
ExpiredValue: number
The point items which have expired. There is no default value, dependency, or limitation associated with this attribute.
-
MemberNumber: string
The member for whom the accrual item is created. There is no default value, dependency, or limitation associated with this attribute.
-
OrderNumber: string
Maximum Length:
30
The number associated with an order. This attribute is used by Oracle Loyalty Cloud when consolidating transactions. There is no default value, dependency, or limitation associated with this attribute. -
PointBlkId: integer
(int64)
Title:
Point Block ID
The attribute indicates the primary key of the point block from which the accrued points are allocated to the member. There is no default value, dependency, or limitation associated with this attribute. -
ProcessDt: string
(date-time)
Title:
Processed Date
The transaction process date. This attribute specifies the day on which the created transaction is processed that resulted in the creation of accrual items. There is no default value, dependency, or limitation associated with this attribute. -
QualifyingFlag: boolean
Title:
Qualifying
Maximum Length:1
Default Value:false
The boolean attribute indicates whether the accrued points are qualifying points or not. Qualifying points count toward a member???s tier status. The default value is N. There is no dependency or limitation associated with this attribute. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The code that represents the status of the accrual item. The accepted values are ORA_LOY_AVAILABLE, ORA_LOY_CANCELLED or ORA_LOY_EXPIRED. There is no default value, dependency, or limitation associated with this attribute. -
TypeCode: string
Title:
Type Code
Maximum Length:30
The point item type code associated with an order. There is no default value, dependency, or limitation associated with this attribute. -
UsedValue: number
Title:
Used Value
The total points from the accrued points that have been used. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyMembers-promotions-item-patch-request
Type:
Show Source
object
-
EligFlg: string
Title:
Eligibility
Maximum Length:1
Default Value:N
Indicates if member is eligible or enrolled. -
EnrollmentEnd: string
(date-time)
Title:
Enrollment End Date
The promotion enrollment end date, which is the date until the current member is enrolled to a particular enrollable promotion. The promotion enrollment end date should be later than promotion enrollment start date. There is no default value associated with this attribute. -
EnrollmentStart: string
(date-time)
Title:
Enrollment Start Date
The date when the promotion enrollment begins. A loyalty member can be enrolled into a particular promotion beginning on this date. There is no default value, dependency, or limitation associated with this attribute. -
IncentiveChoice: string
Title:
Incentive Choice
The incentive choice option for an enrollable promotion. One of the many defined preferred choices can be setup for each member. If no choice is selected for a member, the one defined as a default incentive choice is used. There is no dependency or limitation associated with this attribute. -
LoyPromomemId: integer
(int64)
Title:
Loyalty Promotion Member ID
The loyalty promotion member identifier, which is the primary identifier to uniquely identify a loyalty member enrolled into a loyalty promotion for a given period. There is no default value, dependency, or limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member ID
The primary key of the member identifier who is currently enrolled in an enrollable promotion. There is no default value or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
Maximum Length:30
The loyalty member number, which is an alternative key to identify a member. This number is shown along with the promotion name when identifying a member enrollment into an enrollable promotion for a given start and end date. There is no default value, dependency, or limitation associated with this attribute. -
OfferNum: string
Title:
Offer Number
Maximum Length:30
. -
PromotionName: string
Title:
Promotion Name
The loyalty promotion name which has the enrollable promotion flag enabled and for which the enrollment start and end date is specified for the current loyalty member. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyMembers-vouchers-item-patch-request
Type:
Show Source
object
-
ActionNote: string
Title:
Action Note
Maximum Length:1000
The attribute indicates additional information pertaining to a voucher action for which the voucher was created. There is no default value or limitation associated with this attribute. -
ActivityDate: string
The date used by Oracle Loyalty Cloud to fetch a valid voucher for a given activity date. The ActivityDate attribute is a parameter used in the availableVoucherFinder and the validateVoucherFinder finders. There is no default value, dependency, or limitation associated with this attribute.
-
BasisCode: string
Title:
Voucher Basis
Maximum Length:30
This is a FND lookup value. To get the possible input values, the user needs to first invoke corresponding lovResourcepath URL: ../crmRestApi/resources/11.12.0.0/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_BASIS There is no default value, dependency, or limitation associated with this attribute. -
CurcyExchDt: string
(date)
Title:
Currency Exchange Date
The currency exchange date associated with the voucher. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyAmount: number
Title:
Voucher Discount Value
The currency amount which signifies the value of the voucher based on currency. There is no default value, dependency, nor limitation associated with this attribute. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the voucher. There is no default value, dependency, or limitation associated with this attribute. -
ExpirationDt: string
(date-time)
Title:
Expiration Date
The expiration date of the voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or the attribute value can be provided as an input when creating a voucher using the resource. There is no default value, dependency, or limitation associated with this attribute. -
InvOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the organization that provides the inventory when the user is redeeming the vouchers. There is no default value, dependency, or limitation associated with this attribute. -
LoyMemVchrId: integer
(int64)
Title:
Voucher ID
The primary key identifier which signifies unique value for a generated voucher record. There is no default value, dependency, nor limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member ID
The primary key of the member to whom the voucher is assigned. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
The member number of the loyaltyMember attribute to whom the voucher is assigned. The MemberNumber attribute is used when assigning a voucher or creating a voucher using the resource. The MemberNumber attribute is also used as a parameter in the availableVoucherFinder finder. There is no default value or dependency associated with this attribute. -
OrganizationCode: string
Title:
Organization Code
Maximum Length:18
The organization code associated with the member voucher. There is no default value, dependency, or limitation associated with this attribute. -
ProductNumber: string
Title:
Product Number
The identifier of the product for an existing voucher, that is used for specifying product information. There is no default value, dependency, or limitation associated with this attribute. -
Quantity: number
Title:
Quantity
Default Value:1
The voucher quantity which shows how many vouchers are assigned by the transaction processing. There is no default value or limitation associated with this attribute. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:ORA_VOUC_STATUS_AVLBL
The attribute indicates the status of the voucher. The accepted values can be obtained by invoking fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_STATUS. The StatusCode attribute can be changed from ORA_VOUC_STATUS_AVLBL to ORA_VOUC_STATUS_USED only through a PATCH request. There is no default value, dependency, or limitation associated with this attribute. -
TxnItemId: integer
(int64)
Title:
Transaction Item ID
The transaction item identifier which signifies the transaction identifier assigned while processing the transaction. There is no default value, dependency, nor limitation associated with this attribute. -
UsedDt: string
(date-time)
Title:
Used Date
The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute. -
validFlag: boolean
The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.
-
VchrBasisCode: string
Title:
Discount Type
Maximum Length:30
The attribute indicates the discount type that the voucher offers. Accepted values are ORA_VOUC_BASIS_ABSOLUTE or ORA_VOUC_BASIS_PERCENTAGE. It is provided as input from a user when creating the voucher. There is no default value, dependency, or limitation associated with this attribute. -
VoucherDiscountValue: number
Title:
Voucher Discount Value
The voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, then the value of discount must be a positive integer. This value is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute. -
VoucherEffectiveStartDt: string
(date)
Title:
Start Date
The date when the voucher is in effect. This date is assigned during an Assign Voucher action or when the voucher is created using the resource. There is no default value, dependency, or limitation associated with this attribute.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : loyMembers-item-response
Type:
Show Source
object
-
AccntId: integer
(int64)
Title:
Account ID
The account identifier for the member's partner object of the member referred by current member. If the MemberType attribute is set to Company, then Oracle Loyalty Cloud populates AccountId. This attribute depends on the value of the MemberType attribute. There is no default value or limitation with this attribute. -
AccountPartyNumber: string
Title:
Account Party Number
Read Only:true
Maximum Length:30
The account party number associated with the referred member. There is no default value, dependency, or limitation associated with this attribute. -
AccountTypeCode: string
Title:
Account Type Code
Read Only:true
Maximum Length:30
Default Value:ZCA_PROSPECT
The lookup type code of an account. The lookup type value is ZCA_ACCOUNT_TYPE. There is no default value or limitation associated with this attribute. -
AccrualLookupCode: string
Title:
Accrual Lookup Code
Read Only:true
Maximum Length:30
The accrual lookup code is a read-only attribute that is dependent on AccrualLookupType. This attribute shows information about the referred member. This attribute gives additional information regarding AccrualTypeCode as a lookup code. There is no default value or limitation associated with this attribute. -
AccrualLookupType: string
Title:
Accrual Lookup Type
Read Only:true
Maximum Length:30
The accrual lookup type attribute is a read-only attribute that shows information about the lookup type that is used to display AccrualTypeCode. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
AccrualMeaning: string
Title:
Accrual Type Meaning
Read Only:true
Maximum Length:80
The accrual meaning is a read-only attribute that shows information about the meaning text of the AccrualTypeCode attribute. This attribute shows information about the referred member. This attribute is dependent on AccrualTypeCode. There is no default value or limitation associated with this attribute. -
AccrualStartDate: string
(date-time)
Title:
Accrual Start Date
The date when the member starts accruing points from another member. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
AccrualToHousehold: string
Title:
Accrual to Household Member
Read Only:true
Maximum Length:100
The household to which an Individual member's points can be accrued. There is no default value, dependency, or limitation associated with this attribute. -
AccrualToHouseholdFlag: string
Title:
Accrual to Household
This flag determines whether the accrual due to a transaction completed by a household member should be accrued to a member or to the household to which it belongs. There is no default value associated with this attribute. -
AccrualToMemId: integer
(int64)
Title:
Accrual-to Member ID
The identifier of the member to whose account the points are accrued for a corporate accrual. This attribute shows information about the referred member. This attribute value depends on the AccrualType attribute. There is no default value or limitation associated with this attribute. -
AccrualTypeCode: string
Title:
Accrual Type
Maximum Length:30
The accrual type value, that is an LOV attribute which is based on FND lookups. This attribute shows information about the referred member. For the possible input values of AccrualTypeCode, the integrating user must first invoke the corresponding LOV resource path URL. For example: invoke lovResourcepath ../crmRestApi/resources/11.12.0.0/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_ACCRU_TYPE. There is no default value, dependency, or limitation associated with this attribute. -
activities: array
Activities
Title:
Activities
The activities resource is used to retrive the details of activities associted with the loyalty members. -
AddressLineOne: string
Title:
Individual Address Line 1
Read Only:true
Maximum Length:240
The first line in the address provided by a member contact or account while enrolling. There is no default value, dependency, or limitation associated with this attribute. -
AddressLineThree: string
Title:
Individual Address Line 3
Read Only:true
Maximum Length:240
The third line in the address provided by a member contact or account while enrolling. There is no default value, dependency, or limitation associated with this attribute. -
AddressLineTwo: string
Title:
Individual Address Line 2
Read Only:true
Maximum Length:240
The second line in the address provided by a member contact or account while enrolling. There is no default value, dependency, or limitation associated with this attribute. -
cards: array
Cards
Title:
Cards
The cards resource is used to retrieve the details of membership cards for the given loyalty member. -
City: string
Title:
Individual City
Read Only:true
Maximum Length:60
The city of the contact or account or household, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ContactDateOfBirth: string
(date)
Title:
Date of Birth
Read Only:true
The date when the member was born. This attribute shows information from the corresponding contact used to create the current loyalty member. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the member contact. A single Oracle Sales Cloud contact can be used to enroll into different loyalty programs. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactId: integer
(int64)
Title:
Contact ID
The contact identifier as specified in the Member Contacts object. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the member contact. A single Oracle Sales Cloud contact can be used to enroll into different loyalty programs. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactName: string
Title:
Contact
Maximum Length:450
The name of the contact associated with the member. This attribute shows information about the referred member. This attribute has the format of ContactFirstName ContactLastName. There is no default value, dependency, or limitation associated with this attribute. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The currency code used by the corporation. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CorpMemberNumber: string
Title:
Corporation Member Number
Maximum Length:15
The corporate member number. If the current member is part of the company or corporate account, then Oracle Loyalty Cloud populates this field. This is an optional attribute which is introduced for future use. Oracle Loyalty Cloud does not currently use this attribute. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
Country: string
Title:
Individual Country
Read Only:true
Maximum Length:2
The country of the contact or account or household, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
County: string
Title:
Individual County
Read Only:true
Maximum Length:60
The county of the contact or account or household address, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user that creates the member record. Oracle Loyalty Cloud populates this value when the loyalty administrator creates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Created Date
Read Only:true
The date when the member record is created. Oracle Loyalty Cloud sets this date value when the loyalty administrator creates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
CreationSource: string
Title:
Creation Source
The information detailing the member creation source. This attribute value is set while creating a member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate method that is applied. This rate can apply to an individual or throughout the corporation. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The international currency code used by the loyalty member to complete transactions. International codes such as USD, INR,GBP are valid for this attribute. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyDate: string
(date)
Title:
Currency Date
The date when the currency conversion rate is applied for a given currency code. There is no default value, dependency, or limitation associated with this attribute. -
DateOfBirth: string
(date)
Title:
Date of Birth
Read Only:true
The date when the member was born. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the member. This attribute shows the read-only value of member's email address. While creating a loyalty member under a program, the MemberEmailAddress attribute gets written to the Contact information, which is used to recognize the contact. There is no default value, dependency, or limitation associated with this attribute. -
EnrollFlag: string
Title:
Enrollment Required
The Enroll flag is set when importing a member from a different system to an existing loyalty system. There is no default value or limitation associated with this attribute. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the member. This is one of the Member Contact fields which can be used while enrolling a loyalty member in a program. There is no default value, dependency, or limitation associated with this attribute. -
GroupLookupCode: string
Title:
Group Lookup Code
Read Only:true
Maximum Length:30
The FND lookup code value of the Member Group code. ORA_LOY_MEM_GRP is the lookup type for the Member Travel group. This attribute is dependent on the GroupLookupType attribute. There is no default value or limitation associated with this attribute. -
GroupLookupType: string
Title:
Group Lookup Type
Read Only:true
Maximum Length:30
The FND lookup type value of the Member Group code. ORA_LOY_MEM_GRP is the lookup type for the Member Travel group. There is no default value, dependency, or limitation associated with this attribute. -
GroupMeaning: string
Title:
Member Group Meaning
Read Only:true
Maximum Length:80
The meaning of the current group that the referred loyalty member is in. This has an extended lookup associated with ORA_LOY_MEM_GRP, which is the lookup type for the Member Travel group. This attribute is dependent on the GroupLookupType attribute. There is no default value or limitation associated with this attribute. -
groupMembers: array
Group Members
Title:
Group Members
The group members resource is used to retrieve the details of a group member attribute associated with the loyalty member. -
HHAddressOne: string
Title:
Household Address Line 1
Read Only:true
Maximum Length:240
Address entered in line one of a Household. -
HHAddressThree: string
Title:
Household Address Line 3
Read Only:true
Maximum Length:240
Address entered in line three of a Household. -
HHAddressTwo: string
Title:
Household Address Line 2
Read Only:true
Maximum Length:240
Address entered in line two of a Household. -
HHCity: string
Title:
Household City
Read Only:true
Maximum Length:60
City of a Household. -
HHCountry: string
Title:
Household Country
Read Only:true
Maximum Length:2
Country of a Household. -
HHCounty: string
Title:
Household County
Read Only:true
Maximum Length:60
County of a Household. -
HHPostalCode: string
Title:
Household Postal Code
Read Only:true
Maximum Length:60
Postal Code of a Household. -
HHProvince: string
Title:
Household Province
Read Only:true
Maximum Length:60
Province of a Household. -
HHState: string
Title:
Household State
Read Only:true
Maximum Length:60
State of a Household. -
HouseholdMemberNumber: string
Title:
Household Member Number
The member number of a household to be passed by a payload. This value should be a valid household enrolled already in the same loyalty program. There is no default value associated with this attribute. -
individualMembers: array
Individual Members
Title:
Individual Members
The individual members resource is used to retrieve the details of an individual member attribute associated with the loyalty member. -
JobTitle: string
Title:
Job Title
The job title of a contact which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
LastAccrTransactionDt: string
(date-time)
Title:
Last Accrual Transaction Date
The date when the last accrual transaction for the loyalty member has occurred. There is no default value, dependency, or limitation associated with this attribute. -
LastRdmTransactionDt: string
(date-time)
Title:
Last Redemption Transaction Date
The last redemption transaction date. This attribute shows when the last redemption transaction by the member has occurred. There is no default value, dependency, or limitation associated with this attribute. -
LastTransactionProcedDt: string
(date-time)
Title:
Last Transaction Processed Date
The last transaction process date. This date shows when the last transaction was performed by the loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Change Date
Read Only:true
The date when the member record is updated. Oracle Loyalty Cloud sets this date value when the loyalty administrator updates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Changed By
Read Only:true
Maximum Length:64
The user that updates the member record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of user that updated the member record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeAVal: number
Title:
Lifetime Payment Type A Value
The member's life time point balance in internal point type A. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeBVal: number
Title:
Lifetime Payment Type B Value
The member's life time point balance in internal point type B. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeCVal: number
Title:
Lifetime Payment Type C Value
The member's life time point balance in internal point type C. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeDVal: number
Title:
Lifetime Payment Type D Value
The member's life time point balance in internal point type D. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeEVal: number
Title:
Lifetime Payment Type E Value
The member's life time point balance in internal point type E. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeFVal: number
Title:
Lifetime Payment Type F Value
The member's life time point balance in internal point type F. A program can have up to eight point types, internally referred to as Point type (A to H). Each of the point type has a life time point balance associated with it which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeGVal: number
Title:
Lifetime Payment Type G Value
The member's life time point balance in internal point type G. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeHVal: number
Title:
Lifetime Payment Type H Value
The member's life time point balance in internal point type H. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyAccountName: string
Title:
Account Name
The loyalty member account name for the member's partner object. If the MemberTypeCode attribute is Company, then Oracle Loyalty Cloud populates the account name. This attribute depends on the value of the MemberTypeCode attribute. Oracle Loyalty Cloud populates the AccountName attribute based on the AccountId attribute. There is no default value or limitation associated with this attribute. -
LoyHouseholdName: string
Title:
Household Name
The household member name. If the MemberTypeCode attribute is set to Household, then this attribute shows membership information about the referred household. There is no default value, dependency, or limitation associated with this attribute. -
LoyMemberId: integer
(int64)
Title:
Loyalty Member ID
The primary key of member referred by current loyMember resource. There is no default value, dependency, or limitation associated with this attribute. -
LoyProgramName: string
Title:
Program Name
The name of the loyalty program in which the member has been enrolled. This is a read-only attribute for the read-only child resource MemberReferrals of loyMembers. The LoyProgramName attribute is provided as input while creating the loyalty member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
LstTierChangeDt: string
(date-time)
Title:
Date of Member's Last Tier Change
The date when the member's tier change occurs. Oracle Loyalty Cloud updates this date when a member's tier changes. There is no default value, dependency, or limitation associated with this attribute. -
MemberAttributes: array
Member Attributes
Title:
Member Attributes
The member attributes resource is used to retrieve the details of a member attribute associated with the loyalty member. -
MemberClassCode: string
Title:
Member Class
Maximum Length:30
The FND lookup code value of Member Class as an input of loyalty Members. The possible input values can be obtained by invoking the corresponding lovResourcePath URL: fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_CLASS. -
MemberClassMeaning: string
Title:
Member Class Meaning
Read Only:true
Maximum Length:80
The current class of the loyalty member. This is an extended lookup type attribute of type ORA_LOY_MEM_CLASS. There is no default value, dependency, or limitation associated with this attribute. -
MemberContact: array
Member Contacts
Title:
Member Contacts
The member contact resource is used to retrieve the details of a contact that is associated with the loyalty member. -
MemberEmailAddress: string
Title:
Member Email Address
Read Only:true
Maximum Length:320
The member's email address, which is provided as a input while creating loyalty Member record through REST API. This value will be used to create an Oracle Sales Cloud contact behind the scenes. There is no default value, dependency, or limitation associated with this attribute. -
MemberGrpCode: string
Title:
Member Group
Maximum Length:30
The extended Lookup Type attribute of type ORA_LOY_MEM_GRP which shows information about the member's current group. There is no default value, dependency, or limitation associated with this attribute. -
MemberName: string
Title:
Member Name
Maximum Length:100
The name of the referred loyalty member, which can be provided as input while creating a loyalty member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
Maximum Length:30
The member number of the referred loyalty member. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute. -
MemberPhaseCode: string
Title:
Member Phase
Maximum Length:30
The lookup code value of the member phase used as a an input for loyalty Members. The integrating user must first invoke the lovResourcepath URL for possible input values. The corresponding lovResourcePath URL is ?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_PHASE. There is no default value, dependency, or limitation associated with this attribute. -
MemberPhaseMeaning: string
Title:
Member Phase Meaning
Read Only:true
Maximum Length:80
The current phase for the that the loyalty member. This attribute has an extended lookup associated with ORA_LOY_MEM_PHASE. There is no default value, dependency, or limitation associated with this attribute. -
MemberReferrals: array
Member Referrals
Title:
Member Referrals
The member referrals resource is used to retrieve the contacts that are referred by the loyalty member. -
MembershipSchemeId: integer
(int64)
Title:
Membership Scheme ID
The unique reference to the member scheme, if any, chosen by the user while enrolling into the loyalty program. The member scheme can be a paid or free scheme. For example, a 6 months free membership, or a 1 Year $5 paid membership, and so on. There is no default value, dependency, or limitation associated with this attribute. -
MemberTier: array
Member Tiers
Title:
Member Tiers
The member tier resource is used to retrieve the member tier details for the loyalty member. -
MemberTransactions: array
Member Transactions
Title:
Member Transactions
The member transactions resource is used to retrieve the details of transactions performed by the loyalty member. -
MemberTypeCode: string
Title:
Type
Maximum Length:30
Default Value:ORA_MEM_TYPE_INDIVIDUAL
The member type, which is provided as an input attribute while creating a loyalty member. To know the possible input values, the user must invoke the corresponding lovResourcePath URL ....fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_TYPE. There is no default value, dependency, or limitation associated with this attribute. -
MemberTypeMeaning: string
Title:
Member Type Meaning
Read Only:true
Maximum Length:80
The meaning of the current type that the referred loyalty member is in. This has an extended lookup associated with ORA_LOY_MEM_TYPE, which is the lookup type for the Member Travel group. This attribute is dependent on the MemberLookupType attribute. There is no default value or limitation associated with this attribute. -
MobileNumber: string
Title:
Mobile Number
Read Only:true
Maximum Length:40
The mobile number of the member. This attribute can be provided as input when enrolling a loyalty member into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationAddressOne: string
Title:
Company Address Line 1
Read Only:true
Maximum Length:240
Address of a Account entered in line One. -
OrganizationAddressThree: string
Title:
Company Address Line 3
Read Only:true
Maximum Length:240
The third line of the address provided while enrolling a member as an organization in a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationAddressTwo: string
Title:
Company Address Line 2
Read Only:true
Maximum Length:240
Address of an Account entered in line two. -
OrganizationCity: string
Title:
Company City
Read Only:true
Maximum Length:60
The city part of the address provided by an organization while enrolling a member as an organization in loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationCountry: string
Title:
Company Country
Read Only:true
Maximum Length:2
Country of an Account. -
OrganizationCounty: string
Title:
Company County
Read Only:true
Maximum Length:60
County of an Account. -
OrganizationPostalCode: string
Title:
Company Postal Code
Read Only:true
Maximum Length:60
Postal Code of an Account. -
OrganizationProvince: string
Title:
Company Province
Read Only:true
Maximum Length:60
Province of an Account. -
OrganizationState: string
Title:
Company State
Read Only:true
Maximum Length:60
State of an Account. -
OrgGroupId: integer
(int64)
Title:
Organization Group ID
The organization group identifier to which the loyalty member belongs. There is no default value, dependency, or limitation associated with this attribute. -
OrgGroupPartyNumber: string
Title:
Household Party Number
Read Only:true
Maximum Length:30
The organization group party number associated with the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ParentMember: string
Title:
Parent
Maximum Length:1
Default Value:N
The parent member where the loyalty member is either a household or an individual, but is also a corporate member. There is no default value, dependency, or limitation associated with this attribute. -
PartyName: string
Title:
Contact Party Name
Maximum Length:360
The loyalty partner name as an alternative identifier. Oracle Loyalty Cloud creates this identifier when a loyalty membership is created through a partner as a reference. There is no default value, dependency, or limitation associated with this attribute. -
PartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The party number of the contact associated with the loyalty member. -
PersonFirstName: string
Title:
Primary Contact First Name
Read Only:true
Maximum Length:150
The first name of the member contact in the context of referred member. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same FirstName attribute can be used while enrolling a loyalty member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PersonLastName: string
Title:
Primary Contact Last Name
Read Only:true
Maximum Length:150
The last name of the member contact in the context of the referred member. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same LastName attribute can be used while enrolling a loyalty member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PersonName: string
Title:
Person Name
Maximum Length:450
The full name of the member contact. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same LastName attribute can be used while enrolling a member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:40
The phone number of the member. This is one of the Member Contact fields which can be used while enrolling a loyalty member in a program. There is no default value, dependency, or limitation associated with this attribute. -
pointbalances: array
Point Balances
Title:
Point Balances
The point balances resource is used to retrieve the point balance detail for a loyalty member. -
pointItems: array
Point Items
Title:
Point Items
The point items resource is used to retrieve the point items detail for a loyalty member. -
Points: string
Title:
Points
Read Only:true
Maximum Length:255
Default Value:0
The point balance. This attribute is the numeric value of the point balance of the loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeAVal: number
Title:
Point Type A Value
Default Value:0
The points for the member from Point Type A as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeBVal: number
Title:
Point Type B Value
Default Value:0
The points for the member from Point Type B as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeCVal: number
Title:
Point Type C Value
Default Value:0
The points for the member from Point Type C as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeDVal: number
Title:
Point Type D Value
Default Value:0
The points for the member from Point Type D as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeEVal: number
Title:
Point Type E Value
Default Value:0
The points for the member from Point Type E as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeFVal: number
Title:
Point Type F Value
Default Value:0
The points for the member from Point Type F as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeGVal: number
Title:
Point Type G Value
Default Value:0
The points for the member from Point Type G as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeHVal: number
Title:
Point Type H Value
Default Value:0
The points for the member from Point Type H as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PostalCode: string
Title:
Individual Postal Code
Read Only:true
Maximum Length:60
The postal code of the contact or account or household address, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PrConId: integer
(int64)
Title:
Primary Contact ID
The partner contact identifier. This value can be provided as an input while creating a loyalty member through the resource and when Oracle Loyalty Cloud enrols the corresponding contact as a member in the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PreviousTierName: string
Title:
Previous Tier Name
Read Only:true
The previous tier name from which the loyalty member is promoted to the current tier. There is no default value, dependency, or limitation associated with this attribute. -
ProgramNumber: string
Title:
Program Number
Maximum Length:30
The program number associated with the referred member. There is no default value, dependency, or limitation associated with this attribute. -
PromotionAttributeDetail: array
Promotion Attribute Details
Title:
Promotion Attribute Details
The promotion attribute detail resource is used to retrieve the details of a member promotion attribute associated with the loyalty member. -
promotions: array
Promotions
Title:
Promotions
The promotions resource is used to retrieve the details of a promotion enrolled by the loyalty member. -
Province: string
Title:
Individual Province
Read Only:true
Maximum Length:60
The province of the contact or account or household, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
RealTimeBonusFlag: boolean
Title:
Real Time Bonus
Maximum Length:1
Default Value:false
The real time bonus flag. If this flag is set to Y, then on member enrollment, it processes enrollment and referral bonus transactions in real time. Otherwise, it will create an enrollment bonus and referral bonus transaction and set the status to Queued for the batch engine to pick and process. There is no default value, dependency, or limitation associated with this attribute. -
ReferConId: integer
(int64)
Title:
Referring Member Contact ID
Read Only:true
The primary contact identifier of referral member. This value is shown as additional information regarding the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByNam: string
Title:
Referred By
Maximum Length:100
The member identifier of the referring member name who has referred the current member to the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByName: string
Title:
Referred By
The member identifier by name who has referred the current member to the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByNumber: string
Title:
Referred by Number
Maximum Length:30
The member number of the member who has referred the current member to the loyalty program. This value is input by the user and is validated against the existing member record in Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
RelationshipId: integer
(int64)
Title:
Relationship ID
The relationship identifier which shows the relationship between loyalty members. There is no default value, dependency, or limitation associated with this attribute. -
RelationshipRecId: integer
(int64)
Title:
Relationship Record Identifier
Read Only:true
The relationship record identifier that shows the relationship of the member between other loyalty members. For example, there might be a relationship between an organization and a member. There is no default value, dependency, or limitation associated with this attribute. -
RelationshipType: string
Title:
Relationship Type
Read Only:true
Maximum Length:30
The relationship type showing the type of relation between loyalty members. For example, there might be a relationship between an organization and a member. There is no default value, dependency, or limitation associated with this attribute. -
reltype: string
Title:
Relationship Type
The relationship type showing the type of relation between loyalty members. For example, there might be a relationship between an organization and a member. There is no default value, dependency, or limitation associated with this attribute. -
StartDate: string
(date-time)
Title:
Joining Date
The date when the membership in the loyalty program starts. There is no default value, dependency, or limitation associated with this attribute. -
State: string
Title:
State
Read Only:true
Maximum Length:60
The state code of the contact or account or household, which is provided by member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
Status: string
Title:
Status Meaning
Maximum Length:80
The member status meaning of referred loyalty member which is a read-only value based on the Status code attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_STATUS lookup. There is no default value or limitation associated with this attribute. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:ORA_MEM_STATUS_ACTIVE
The status code of the loyalty member, which is a read-only value based on the Status attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_STATUS lookup. There is no default value or limitation associated with this attribute. -
SuppressCall: string
Title:
Suppress Call
The attribute indicates that the member does not want to receive any calls pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressCallFlag: boolean
Title:
Block Member Call Contact
Maximum Length:1
Default Value:false
Block Member Call Contact. -
SuppressEmail: string
Title:
Suppress Email
The attribute indicates that the member does not want to receive any mail pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressEmailFlag: boolean
Title:
Block Member Email Contact
Maximum Length:1
Default Value:false
Block Member Email Contact. -
SuppressFax: string
Title:
Suppress Fax
The attribute indicates that the member does not want to receive any fax pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressFaxFlag: boolean
Title:
Block Member Fax Contact
Maximum Length:1
Default Value:false
Block Member Fax Contact. -
SuppressMail: string
Title:
Suppress Mail
The attribute indicates that the member does not want to receive any mail pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressMailFlag: boolean
Title:
Block Member Mail Contact
Maximum Length:1
Default Value:false
Block Member Mail Contact. -
SuppressSMS: string
Title:
Suppress SMS
The attribute indicates that the member does not want to receive any SMS pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressSMSFlag: boolean
Title:
Block Member SMS Contact
Maximum Length:1
Default Value:false
Block Member SMS Contact. -
SurvMemNumber: string
Title:
Surviving Member Number
Maximum Length:30
The surviving member number associated with the referred member. There is no default value, dependency, or limitation associated with this attribute. -
TierName: string
Title:
Tier
Read Only:true
Maximum Length:255
The tier name of the current tier of the loyalty member. The tier calculation is done by the Oracle Loyalty Cloud engine. This attribute value is set by the Oracle Loyalty Cloud engine when performing the tier assessment of the loyalty member based on the qualifying point balance of the member. There is no default value, dependency, or limitation associated with this attribute. -
URL: string
The member URL which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute.
-
ValLifeScore: string
Title:
Lifetime Value Score
Maximum Length:50
The life time value score of the loyalty member as the highest watermark value. There is no default value, dependency, or limitation associated with this attribute. -
vouchers: array
Vouchers
Title:
Vouchers
The vouchers resource is used to retrieve the vouchers that are assigned to the loyalty member. -
WorkPhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:40
The work phone number of the referred member. The WorkPhoneNumber attribute is another contact related attribute which shows the secondary formatted phone number if the primary phone number Is not available. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Activities
Type:
array
Title:
Activities
The activities resource is used to retrive the details of activities associted with the loyalty members.
Show Source
Nested Schema : Cards
Type:
array
Title:
Cards
The cards resource is used to retrieve the details of membership cards for the given loyalty member.
Show Source
Nested Schema : Group Members
Type:
array
Title:
Group Members
The group members resource is used to retrieve the details of a group member attribute associated with the loyalty member.
Show Source
Nested Schema : Individual Members
Type:
array
Title:
Individual Members
The individual members resource is used to retrieve the details of an individual member attribute associated with the loyalty member.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Member Attributes
Type:
array
Title:
Member Attributes
The member attributes resource is used to retrieve the details of a member attribute associated with the loyalty member.
Show Source
Nested Schema : Member Contacts
Type:
array
Title:
Member Contacts
The member contact resource is used to retrieve the details of a contact that is associated with the loyalty member.
Show Source
Nested Schema : Member Referrals
Type:
array
Title:
Member Referrals
The member referrals resource is used to retrieve the contacts that are referred by the loyalty member.
Show Source
Nested Schema : Member Tiers
Type:
array
Title:
Member Tiers
The member tier resource is used to retrieve the member tier details for the loyalty member.
Show Source
Nested Schema : Member Transactions
Type:
array
Title:
Member Transactions
The member transactions resource is used to retrieve the details of transactions performed by the loyalty member.
Show Source
Nested Schema : Point Balances
Type:
array
Title:
Point Balances
The point balances resource is used to retrieve the point balance detail for a loyalty member.
Show Source
Nested Schema : Point Items
Type:
array
Title:
Point Items
The point items resource is used to retrieve the point items detail for a loyalty member.
Show Source
Nested Schema : Promotion Attribute Details
Type:
array
Title:
Promotion Attribute Details
The promotion attribute detail resource is used to retrieve the details of a member promotion attribute associated with the loyalty member.
Show Source
Nested Schema : Promotions
Type:
array
Title:
Promotions
The promotions resource is used to retrieve the details of a promotion enrolled by the loyalty member.
Show Source
Nested Schema : Vouchers
Type:
array
Title:
Vouchers
The vouchers resource is used to retrieve the vouchers that are assigned to the loyalty member.
Show Source
Nested Schema : loyMembers-activities-item-response
Type:
Show Source
object
-
AccrualActionNote: string
Title:
Action Note
Read Only:true
Maximum Length:1000
The action note associated with the accrual activity. There is no default value, dependency, or limitation associated with this attribute. -
AccrualDisputeStatusCode: string
Read Only:
true
Maximum Length:30
The attribute specifies the status of the created accrual dispute, that is, whether the accrual dispute created is approved or rejected. The accepted values are ORA_ACRL_DISPUTE_STAT_APPR and ORA_ACRL_DISPUTE_STAT_REJ. There is no default value, dependency, or limitation associated with this attribute. -
AccrualDisputeTypeCode: string
Read Only:
true
Maximum Length:30
The attribute specifies the type of Accrual Dispute that is created. Accepted values are ORA_ACRL_DISPUTE_TYPE_INCOR and ORA_ACRL_DISPUTE_TYPE_MISSING. There is no default value, dependency, or limitation associated with this attribute. -
AccrualedValue: number
Title:
Number of Points
Read Only:true
The number of accrued points. This attribute gets updated whenever the transaction creates accrual items and assigns points during transaction processing. There is no default value, dependency, or limitation associated with this attribute. -
AccrualEffDt: string
(date-time)
Title:
Accrual Start Date
Read Only:true
Displays the date from which the points become effective, that is, the date when the points are available for redemption. Point items having a future effective date will fall under the Future Points category and would move under Available Points once the effective date is reached. There is no default value, dependency, or limitation associated with this attribute. -
AccrualPointBlockNumber: string
Title:
Point Block Number
Read Only:true
Maximum Length:30
The point block number associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
AccrualPromotionName: string
Title:
Name
Read Only:true
Maximum Length:50
The promotion name associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
AccrualTotalPoints: number
Title:
Original Points
Read Only:true
The total accrual points associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
AcrlStatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
The accrual status code associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
ActivityDate: string
(date-time)
Title:
Activity Date
Read Only:true
The date when a transaction activity occurs. The transaction can be an accrual or redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
ActivityDay: number
Title:
Activity Day
Read Only:true
The transaction activity day. This attribute represents the day when an activity, either accrual or redemption, occurs. There is no default value, dependency, or limitation associated with this attribute. -
ActivityHour: number
Title:
Activity Hour
Read Only:true
The transaction activity hour. This attribute represents the time in hours when an activity, either accrual or redemption, occurs. There is no default value, dependency, or limitation associated with this attribute. -
AmountValue: number
Title:
Amount
Read Only:true
The total amount spent on the accrual or redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
ApproveDt: string
(date-time)
Title:
Approve Date
Read Only:true
The transaction approval date. If the transactions involve an approval process, then the identifier indicates the date when the transaction is approved by the reviewer. There is no default value, dependency, or limitation associated with this attribute. -
BookClassCode: string
Title:
Book Class Code
Read Only:true
Maximum Length:30
The booking class code. This attribute specifies the class of the airline ticket. The accepted values are ORA_TRAVL_BOOK_BUSI or ORA_TRAVL_BOOK_ECO. There is no default value, dependency, or limitation associated with this attribute. -
BookingDt: string
(date-time)
Title:
Booking Date
Read Only:true
The transaction booking date. If the transaction is an airline transaction, then this attribute indicates the date when the booking is made for travel. There is no default value, dependency, or limitation associated with this attribute. -
CancelledTransactionId: integer
(int64)
Title:
Canceled Transaction ID
Read Only:true
The canceled transaction identifier associated with the activity. This attribute is the primary key of the transaction that is canceled. There is no default value, dependency, or limitation associated with this attribute. -
CancReasonCode: string
Title:
Cancellation Reason Code
Read Only:true
Maximum Length:30
The cancellation reason code. This attribute value represents the reason why the transaction is canceled. There is no default value, dependency, or limitation associated with this attribute. -
ChildTransactionId: integer
(int64)
Title:
Child Transaction ID
Read Only:true
The child transaction identifier. This attribute is the primary key of the transaction that is the child of the current transaction. There is no default value, dependency, or limitation associated with this attribute. -
Comments: string
Title:
Comments
Read Only:true
Maximum Length:250
The comments on transaction associated with the activity. This attribute stores the comments entered by user, if any, for future reference. There is no default value, dependency, or limitation associated with this attribute. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Read Only:true
Maximum Length:15
The currency code used by the corporation. There is no default value, dependency, or limitation associated with this attribute. -
CorporateReferenceNumber: string
Title:
Corporate Reference Number
Read Only:true
Maximum Length:30
The reference to a third-party corporate member from the program to get the points split for the individual and the corporation or company, if an individual member completes a transaction on behalf of the corporation or company. There is no default value, dependency, or limitation associated with this attribute. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user that creates the activity record. Oracle Loyalty Cloud populates this value when the loyalty administrator creates the activity in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the activity record is created. Oracle Loyalty Cloud sets this date value when the loyalty administrator creates the activity in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
CurcyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:20
The transaction currency code. This attribute indicates the currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value or dependency associated with this attribute. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Read Only:true
Maximum Length:30
The currency conversion rate method that is applied for the transaction. There is no default value, dependency, or limitation associated with this attribute. -
CurcyExchDt: string
(date-time)
Title:
Currency Exchange Date
Read Only:true
The date when the currency exchange occurs during the transaction creation of associated activity. There is no default value, dependency, or limitation associated with this attribute. -
DestAirportCode: string
Title:
Destination Airport Code
Read Only:true
Maximum Length:30
The destination airport code. This attribute value is a code representing the airport where the flight arrives when reaching its destination. The accepted values are ORA_AIRPORT_BOM, ORA_AIRPORT_BOS, or ORA_AIRPORT_SFO. There is no default value, dependency, or limitation associated with this attribute. -
DestCityCode: string
Title:
Destination City
Read Only:true
Maximum Length:30
The destination city code. This attribute value represents the city where the flight arrives when it reaches its destination. There is no default value, dependency, or limitation associated with this attribute. -
DestZoneCode: string
Title:
Destination Zone Code
Read Only:true
Maximum Length:30
The zone where the flight arrives when it reaches its destination. The list of possible values are ORA_AIRLINE_ZONE_ASIA, ORA_AIRLINE_ZONE_EUROPE, or ORA_AIRLINE_ZONE_NAMER. There is no default value, dependency, or limitation associated with this attribute. -
DocumentNumber: string
Title:
Document Number
Read Only:true
Maximum Length:30
The document number of transaction associated with the activity. This attribute provides additional information in the transaction for the retail industry. There is no default value, dependency, or limitation associated with this attribute. -
EndDt: string
(date-time)
Title:
End Date
Read Only:true
The transaction end date of associated activity. This attribute is the date when the transaction is no longer in effect. This attribute value, if provided, must be set to a value after the StartDt attribute. There is no default value or dependency associated with this attribute. -
ExpirationDt: string
(date-time)
Title:
Expiration Date
Read Only:true
The expiration date for the points that have accrued. There is no default value, dependency, or limitation associated with this attribute. -
ExpireInDays: number
Title:
Expires in Days
Read Only:true
The date when the accrued points will expire, in days. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductLine: string
Title:
External Product Line
Read Only:true
Maximum Length:30
The product line associated with the product for the transaction that is from an external source. The accepted value is ORA_EXT_PROD_LINE_CG. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductName: string
Title:
External Product Name
Read Only:true
Maximum Length:240
The product name reference in the external system. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductType: string
Title:
External Product Type
Read Only:true
Maximum Length:30
The type of products coming into the Oracle Loyalty Cloud system from an external source. The accepted value is ORA_EXT_PROD_TYPE_ELEC. There is no default value, dependency, or limitation associated with this attribute. -
ExternalReservationNumber: string
Title:
External Reservation Number
Read Only:true
Maximum Length:250
The external reservation number is specific to the airline industry where a reservation is performed by an agent and has different reservation numbers. There is no default value, dependency, or limitation associated with this attribute. -
ExternalTransaction: string
Title:
External
Read Only:true
Maximum Length:1
Default Value:N
The external transaction associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
FareBasis: string
Title:
Fare Basis
Read Only:true
Maximum Length:30
The transaction fare basis. This attribute is a code which represents the fare basis on which the ticket fare is based. The accepted values are ORA_FARE_BASIS_BUSI or ORA_FARE_BASIS_ECO. There is no default value, dependency, or limitation associated with this attribute. -
FareBasisCode: string
Title:
Fare Basis Code
Read Only:true
Maximum Length:30
The transaction fare basis. This attribute is a code which represents the fare basis on which the ticket fare is based. The accepted values are ORA_FARE_BASIS_BUSI or ORA_FARE_BASIS_ECO. There is no default value, dependency, or limitation associated with this attribute. -
FareTypeCode: string
Title:
Fare Type Code
Read Only:true
Maximum Length:30
The fare type code. This attribute is a code value that determines the class of the flight travel. The accepted values are ORA_FARE_BUSN_CLASS or ORA_FARE_FIRST_CLASS. There is no default value, dependency, or limitation associated with this attribute. -
FlightNumber: string
Title:
Flight Number
Read Only:true
Maximum Length:30
The transaction flight number. If the transaction pertains to airlines, then this attribute indicates the flight number of the flight where the travel takes place. This attribute is entered by the user during transaction creation. There is no default value, dependency, or limitation associated with this attribute. -
FltTypeCode: string
Title:
Flight Type Code
Read Only:true
Maximum Length:30
The attribute specifies the flight type, for example, Boeing or Airbus. There is no default value, dependency, or limitation associated with this attribute. -
GdsRecLocator: string
Title:
GDS Record Locator
Read Only:true
Maximum Length:30
The global distribution system (GDS) record locator. There is no default value, dependency, or limitation associated with this attribute. -
IncentivChoice: string
Title:
Incentive Choice
Read Only:true
Maximum Length:30
The incentives or rewards that a member receives for enrolling into a promotion. There is no default value, dependency, or limitation associated with this attribute. -
IntegrationId: string
Title:
Integration ID
Read Only:true
Maximum Length:30
The attribute indicates the integration identifier of transaction associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
InternalDest: string
Title:
Internal Destination
Read Only:true
Maximum Length:15
The details of the destination that is used internally by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
InternalFlightDt: string
(date-time)
Title:
Internal Flight Date
Read Only:true
The local date for the flight for the country. For example, 24/01/2018 is equal to GMT +5.30 in India. There is no default value, dependency, or limitation associated with this attribute. -
InternalOrigin: string
Title:
Internal Origin
Read Only:true
Maximum Length:15
The flight origin details that are local to the region. There is no default value, dependency, or limitation associated with this attribute. -
InventoryItemId: integer
(int64)
Read Only:
true
The inventory item identifier. For example, when a transaction is created, sometimes the inventory or goods are picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is being picked from a different organization. There is no default value, dependency, or limitation associated with this attribute. -
InvOrgId: integer
(int64)
Title:
Inventory Organization ID
Read Only:true
The organization from where inventory is being picked. For example, when a transaction is created, sometimes the inventory or goods are picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is being picked from a different organization. There is no default value, dependency, or limitation associated with this attribute. -
ItemNumber: string
Title:
Item Number
Read Only:true
Maximum Length:30
The transaction item number that is used during transaction creation. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the activity record is updated. Oracle Loyalty Cloud sets this date value when the loyalty administrator updates the activity. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date of the last update of the activity record by the user. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the activity. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The activity record that was last updated by the user login. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the activity. There is no default value, dependency, or limitation associated with this attribute. -
LineItemNumber: integer
(int64)
Title:
Order Line Number
Read Only:true
The line item number for a multiple line item order transaction. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoanBalance: number
Title:
Loan Balance
Read Only:true
The remaining balance of the loan that you can use during transaction creation of associated activity. There is no default value, dependency, or limitation associated with this attribute. -
LoanRepaymentDt: string
(date-time)
Title:
Loan Repayment Date
Read Only:true
The date which specifies when the loan is repaid. There is no default value, dependency, or limitation associated with this attribute. -
LocationCode: integer
(int64)
Title:
Location ID
Read Only:true
The transaction location code which is used for giving promotions only for specific locations. For example, for the same retailer, the promotion can be applied only if the store is located in India. If the store is located outside India, then no promotions are applied. There is no default value, dependency, or limitation associated with this attribute. -
LoyTransactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
The transaction attribute associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
MarketingFlightNumber: string
Title:
Marketing Flight Number
Read Only:true
Maximum Length:30
The marketing flight number, which is specific to the airline industry and which indicates the flight number used in the airline's marketing campaign. There is no default value, dependency, or limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member
Read Only:true
The primary key of the member referred by the current loyMember resource. There is no default value, dependency, or limitation associated with this attribute. -
MemberName: string
Title:
Member Name
Read Only:true
Maximum Length:100
The identifier that specifies the name of the loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
Read Only:true
Maximum Length:30
The member number attribute is an alternative identifier that uniquely identifies a loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
OptyCost: number
Title:
Opportunity Cost
Read Only:true
The transaction opportunity cost of transaction associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
OrderNumber: string
Title:
Order Number
Read Only:true
Maximum Length:30
The number associated with an order. This attribute is used by Oracle Loyalty Cloud when consolidating transactions. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationId: integer
(int64)
Read Only:
true
The unique identifier of the organization associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
OrigAirportCode: string
Title:
Origin Airport Code
Read Only:true
Maximum Length:30
The origin airport code. This attribute value represents the airport from where the flight departs. There is no default value, dependency, or limitation associated with this attribute. -
OriginCityCode: string
Title:
Origin City Code
Read Only:true
Maximum Length:30
The origin city code. This attribute value represents the city from where the flight departs. There is no default value, dependency, or limitation associated with this attribute. -
OrigOrderId: integer
(int64)
Title:
Original Order ID
Read Only:true
The attribute indicates the original order identifier that lead to the creation of these transactions. There is no default value, dependency, or limitation associated with this attribute. -
OrigOrdItmId: integer
(int64)
Title:
Original Order Line Item
Read Only:true
The details of the order item that is originally placed, especially used for exchanges, and so on, in retail transactions. There is no default value, dependency, or limitation associated with this attribute. -
OrigPoints: number
Title:
Original Point
Read Only:true
The original value of the transaction in points without any subsequent bonus added by each promotion. There is no default value, dependency, or limitation associated with this attribute. -
OrigZoneCode: string
Title:
Origin Zone Code
Read Only:true
Maximum Length:30
The code representing the zone from where the flight departs. Possible values are ORA_AIRLINE_ZONE_ASIA, ORA_AIRLINE_ZONE_EUROPE, or ORA_AIRLINE_ZONE_NAMER. There is no default value, dependency, or limitation associated with this attribute. -
OvrDupCheck: string
Title:
Duplicate Check Overridden
Read Only:true
Maximum Length:1
Default Value:N
The flag that indicates whether duplicate line items are allowed in a transaction or not. There is no default value, dependency, or limitation associated with this attribute. -
OwnedByMemberId: integer
(int64)
Read Only:
true
The primary key of the member referred by the current loyMember resource that owns this activity. There is no default value, dependency, or limitation associated with this attribute. -
OwnerId: integer
(int64)
Title:
Owner ID
Read Only:true
The user that created the transaction and that owns the transaction. There is no default value, dependency, or limitation associated with this attribute. -
PackageCode: string
Title:
Package Code
Read Only:true
Maximum Length:30
The transaction package code. This attribute identifies the package from which line items are picked. There is no default value, dependency, or limitation associated with this attribute. -
ParentTransactionId: integer
(int64)
Title:
Partner Transaction ID
Read Only:true
The transaction identifier for the parent transaction that creates the current transaction associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
PartitionName: string
Title:
Partition Name
Read Only:true
Maximum Length:30
The transaction partition name. There is no default value, dependency, or limitation associated with this attribute. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The party identifier associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the party associted with the activity. There is no default value, dependency, or limitation associated with this attribute. -
PeriodDurCode: string
Title:
Period Duration
Read Only:true
Maximum Length:30
The period duration code which specifies the duration in days, or months, and so on. There is no default value, dependency, or limitation associated with this attribute. -
PeriodTypeCode: string
Title:
Period Type
Read Only:true
Maximum Length:30
The period type code. Period type options are Months, Years, Lifetime, and so on. There is no default value, dependency, or limitation associated with this attribute. -
PnrName: string
Title:
PNR Name
Read Only:true
Maximum Length:50
The transaction passenger name record (PNR) name. There is no default value, dependency, or limitation associated with this attribute. -
PnrNumber: string
Title:
PNR Number
Read Only:true
Maximum Length:50
The transaction passenger name record (PNR) number. There is no default value, dependency, or limitation associated with this attribute. -
Points: number
Title:
Number Points
Read Only:true
The transaction points of transaction associated with the activity. This attribute corresponds to the price of the transaction in points. There is no default value, dependency, or limitation associated with this attribute. -
PostDt: string
(date-time)
Title:
Post Date
Read Only:true
The date when the transaction associated with the activity is posted. There is no default value, dependency, or limitation associated with this attribute. -
PriceOverriden: string
Title:
Price Overridden
Read Only:true
Maximum Length:1
Default Value:N
The flag that indicates whether the price needs to be overridden or not. There is no default value, dependency, or limitation associated with this attribute. -
ProcessDt: string
(date-time)
Title:
Process Date
Read Only:true
The activity processed date. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingComment: string
Title:
Processing Comment
Read Only:true
Maximum Length:1000
The transaction processing comment that provides the details of an error during transaction processing, if any occurred. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingLog: string
Title:
Processing Log
Read Only:true
Maximum Length:1000
The transaction processing log that provides details of all the promotions that are applied, all the points that are assigned, and all the vouchers that are assigned, if any. There is no default value, dependency, or limitation associated with this attribute. -
ProductName: string
Title:
Product
Read Only:true
Maximum Length:240
The product name reference in the external system. There is no default value, dependency, or limitation associated with this attribute. -
ProgramName: string
Title:
Program
Read Only:true
Maximum Length:50
The name of the program in which the transaction is created. There is no default value, dependency, or limitation associated with this attribute. -
ProgramNumber: string
Title:
Program Number
Read Only:true
Maximum Length:30
The number of the program in which the transaction is created. There is no default value, dependency, or limitation associated with this attribute. -
PtnrProcDt: string
(date-time)
Title:
Partner Processing Date
Read Only:true
The date on which the transaction associated with the activity is processed at the partner end. There is no default value, dependency, or limitation associated with this attribute. -
PtnrStatusCode: string
Title:
Partner Status Code
Read Only:true
Maximum Length:30
The status code used by the partner when processing the transaction. There is no default value, dependency, or limitation associated with this attribute. -
PymtTypeCode: string
Title:
Payment Type
Read Only:true
Maximum Length:30
The payment type code specifies how the payment is made for the transaction. There is no default value, dependency, or limitation associated with this attribute. -
QualifyingFlag: boolean
Title:
Qualifying
Read Only:true
Maximum Length:1
Default Value:false
The boolean attribute indicates whether the accrued points are qualifying points or not. Qualifying points count toward a member???s tier status. The default value is N. There is no dependency or limitation associated with this attribute. -
QualifyingPointUsed: string
Title:
Qualifying
Read Only:true
Maximum Length:1
Default Value:N
The qualifying point associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
ReasonCode: string
Title:
Reason Code
Read Only:true
Maximum Length:30
The reason for the cancellation or refund, if the transaction is cancelled. For example, a fee that is inadvertently applied. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionActionNote: string
Title:
Action Note
Read Only:true
Maximum Length:1000
The action note associated with the redemption activity. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionLoyPromoId: integer
(int64)
Title:
Loyalty Promotion ID
Read Only:true
The redemption promotion identifier associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionPointBlockNumber: string
Title:
Point Block Number
Read Only:true
Maximum Length:30
The redemption point block number associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionProgPointBlockId: integer
(int64)
Read Only:
true
The redemption point block identifier associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionPromotionName: string
Title:
Name
Read Only:true
Maximum Length:50
The redemption promotion name associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionQuantityUOMCode: string
Title:
Unit of Measure for the Redemption Quantity
Read Only:true
Maximum Length:30
The redemption products quantity unit of measure (UOM) code. For example, possible UOM codes are kilograms or litres. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionTotalPoints: number
Title:
Original Points
Read Only:true
The redemption points associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionTypeCode: string
Title:
Type Code
Read Only:true
Maximum Length:30
The redemption lookup code attribute is a read-only attribute that is dependent on RedemptionLookupType. This attribute gives additional information regarding RedemptionTypeCode as a lookup code. There is no default value or limitation associated with this attribute. -
RedemptionValue: number
Title:
Redemption Item Value
Read Only:true
The points redeemed from the activity. There is no default value, dependency, or limitation associated with this attribute. -
RefundPct: number
Title:
Refund Percentage
Read Only:true
The percentage of the refund that is granted in the transaction. There is no default value, dependency, or limitation associated with this attribute. -
RfndOvrdCmnts: string
Title:
Refund Override Comments
Read Only:true
Maximum Length:250
The refund override comments in the event a refund is made. There is no default value, dependency, or limitation associated with this attribute. -
RfndOvrdRsnCode: string
Title:
Refund Override Reason
Read Only:true
Maximum Length:30
The refund override reason code in the event a refund is made. There is no default value, dependency, or limitation associated with this attribute. -
SmActionTypeCode: string
Title:
Social Media Action Type Code
Read Only:true
Maximum Length:30
The code that provides the social media action type. The accepted values are ORA_SOCIAL_ACTION_CHECK_IN, ORA_SOCIAL_ACTION_RATE, or ORA_SOCIAL_ACTION_SHARE. There is no default value, dependency, or limitation associated with this attribute. -
SourceCode: string
Title:
Source Code
Read Only:true
Maximum Length:30
The code that represents the source of the transaction. The possible values are ORA_TXN_SOURCE_WEB, ORA_TXN_SOURCE_MOBILE, ORA_TXN_SOURCE_BILL. There is no default value, dependency, or limitation associated with this attribute. -
StartDt: string
(date-time)
Title:
Start Date
Read Only:true
The start date of transaction associated with the activity. Either Oracle Loyalty Cloud generates this attribute value when a new transaction is created and populates the attribute with the current date, or it is provided as input from the user when creating transaction using the resource. There is no default value, dependency, or limitation associated with this attribute. -
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
Default Value:ORA_TXN_STAT_IN_PROG
The transaction status code associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
StatusMeaning: string
Title:
Status Meaning
Read Only:true
Maximum Length:80
The transaction status meaning. There is no default value, dependency, or limitation associated with this attribute. -
SubmitDt: string
(date-time)
Title:
Submit Date
Read Only:true
The submission date of transaction associated with the activity. Oracle Loyalty Cloud assigns this attribute value when the transaction is submitted for approval by changing the Transaction Status attribute value to Submitted. There is no default value, dependency, or limitation associated with this attribute. -
SubStatusCode: string
Title:
Product ID
Read Only:true
Maximum Length:30
The code that specifies the status of the transaction processing, for example, whether there is an error or the transaction is successful, and so on. The accepted values are ORA_TXN_SUB_STAT_ERROR, ORA_TXN_SUB_STAT_SUCCESS, or ORA_TXN_SUB_STAT_NO_PROMO_QF. There is no default value, dependency, or limitation associated with this attribute. -
SubTypeCode: string
Title:
Subtype Code
Read Only:true
Maximum Length:30
The transaction sub type code associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
SubTypeMeaning: string
Title:
Subtype
Read Only:true
Maximum Length:80
The transaction sub type meaning of the transaction associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
TicketNumber: string
Title:
Ticket Number
Read Only:true
Maximum Length:30
The unique number that is used to identify the ticket booking for an airline transaction. There is no default value, dependency, or limitation associated with this attribute. -
ToMemberNumber: string
Title:
Recipient Membership Number
Read Only:true
Maximum Length:30
The unique identification number of the member to whom points are transferred. There is no default value, dependency, or limitation associated with this attribute. -
TotalDays: integer
(int64)
Title:
Total Days
Read Only:true
The total days that are required for travel between the source and destination locations. There is no default value, dependency, or limitation associated with this attribute. -
TotalLines: number
Title:
Total Lines
Read Only:true
The total line items for the transaction. A transaction can include many order line items. There is no default value, dependency, or limitation associated with this attribute. -
TransactionChannelCode: string
Title:
Transaction Channel Code
Read Only:true
Maximum Length:30
The code that indicates how the transaction is created. The accepted values are ORA_TXN_CHANNEL_MOBILE, ORA_TXN_CHANNEL_WEB, or ORA_TXN_CHANNEL_TELE. There is no default value, dependency, or limitation associated with this attribute. -
TransactionDate: string
(date-time)
Title:
Transaction Date
Read Only:true
The transaction date of the associated activity. There is no default value, dependency, or limitation associated with this attribute. -
TransactionNumber: string
Title:
Transaction Number
Read Only:true
Maximum Length:30
The transaction number associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
TransactionSourceCode: string
Title:
Transaction Source Code
Read Only:true
Maximum Length:30
The transaction source code attribute indicates the transaction activity type, such as Airlines, Hotels, Car Rental, and so on. There is no default value, dependency, or limitation associated with this attribute. -
TrvClassCode: string
Title:
Transfer Class Code
Read Only:true
Maximum Length:30
The code that indicates the class in which the passenger is traveling. The accepted values are ORA_TRAVL_CLASS_BUSI, ORA_TRAVL_CLASS_ECO. There is no default value, dependency, or limitation associated with this attribute. -
TrvlDistance: number
Title:
Travel Distance
Read Only:true
The transaction travel distance. This attribute stores the total miles travelled. There is no default value, dependency, or limitation associated with this attribute. -
TypeCode: string
Title:
Type Code
Read Only:true
Maximum Length:30
The transaction type code associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
TypeMeaning: string
Title:
Type Meaning
Read Only:true
Maximum Length:80
The transaction type meaning of the transaction associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
UnaccMinor: string
Title:
Unaccounted Minor
Read Only:true
Maximum Length:1
Default Value:N
The unaccounted transaction for a minor, that is below the age of majority associated with the activity. There is no default value, dependency, or limitation associated with this attribute. -
ValStatusCode: string
Title:
Value Status Code
Read Only:true
Maximum Length:30
The status of the validation performed on the record. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : loyMembers-cards-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
The attribute indicates whether a member card is active or inactive. There is no default value, dependency, nor limitation associated with this attribute. -
CardNumber: string
Title:
Card Number
Maximum Length:30
The primary key to identify a loyalty membership card. Oracle Loyalty Cloud generates this attribute value during the creation of a membership card record. There is no default value, dependency, or limitation associated with this attribute. -
CardStatus: string
Title:
Card Status
The card status attribute specifies the status of the membership card. The possible values are Active, Stolen, Expired, Lost, and so on. Oracle Loyalty Cloud checks the membership card validity during accrual processing or when the membership card is being used for any rewards, based on the membership card status and the expiry date. There is no default value, dependency, or limitation associated with this attribute. -
CardType: string
Title:
Card Type Meaning
The attribute specifies the membership card type. The accepted values are Gold, Platinum, Silver, and so on. Based on the card type, members are entitled to different rewards. For example, in the airline industry, members usually show their membership cards to prove their tier status in order to be able to use special lounges. There is no default value, dependency, or limitation associated with this attribute. -
CardTypeCode: string
Title:
Card Type
Maximum Length:30
The member card type code which shows values based on lookup type ORA_LOY_MEM_CARD_TYPE. There is no default value or limitation associated with this attribute. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user that creates the membership card record. Oracle Loyalty Cloud populates this value when the loyalty administrator creates the membership card in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the membership card record is created. Oracle Loyalty Cloud sets this date value when the loyalty administrator creates the membership card in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
ExpiryDate: string
(date-time)
Title:
Expiration Date
The expiry date attribute specifies when the membership card expires. There is no default value, dependency, or limitation associated with this attribute. -
ExpiryDateOnCard: string
(date-time)
Title:
Expiration Date on Card
The expiration date displayed on the card that specifies when the membership card expires. There is no default value, dependency, or limitation associated with this attribute. -
ExpiryStampedOnCard: string
Read Only:
true
The expiration date displayed on the card that specifies when the membership card expires. There is no default value, dependency, or limitation associated with this attribute. -
IssueDate: string
(date-time)
Title:
Issued Date
The issue date attribute specifies when the membership card is issued. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the membership card record is updated. Oracle Loyalty Cloud sets this date value when the loyalty administrator updates the membership card in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Last Update By
Read Only:true
Maximum Length:64
The user that updates the membership card record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the membership card in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of user that updated the membership card record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the membership card in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyCardId: integer
(int64)
Title:
Card ID
The primary key to identify a loyalty membership card. Oracle Loyalty Cloud generates this attribute value during the creation of a membership card record. There is no default value, dependency, or limitation associated with this attribute. -
MemberName: string
Title:
Member Name
Read Only:true
Maximum Length:100
The identifier specifies the name of the loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
Maximum Length:30
The member number attribute is an alternative identifier that uniquely identifies a loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
MemberStatus: string
Read Only:
true
The status of the loyalty member. The accepted values are Active, InActive, Dormant, and so on. There is no default value, dependency or limitation associated with this attribute. -
MemberTier: string
Read Only:
true
The identifier specifies the tier to which the member belongs, for example, Gold, Silver, and so on. Oracle Loyalty Cloud generates a membership card for a member when the member joins a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
MemTierNum: string
Title:
Member Tier Number
Read Only:true
Maximum Length:30
The unique identifier which shows the number of the tier to which the loyalty membership card belongs. There is no default value, dependency, or limitation associated with this attribute. -
NameOnCard: string
Title:
Name on Card
Maximum Length:50
The member name that is displayed on the membership card. There is no default value, dependency, or limitation associated with this attribute. -
ProgramName: string
Title:
Program
Read Only:true
Maximum Length:50
The name of the loyalty program in which the current loyalty member is enrolled. There is no default value, dependency, or limitation associated with this attribute. -
RequestDate: string
(date-time)
Title:
Requested Date
The date when a request is placed for receiving the membership card. There is no default value, dependency, or limitation associated with this attribute. -
StartDate: string
(date-time)
Title:
Start Date
The date when the membership card is valid, after when the card can be used to receive rewards or special lounge services, and so on, based on the card type. There is no default value, dependency, or limitation associated with this attribute. -
StatusCode: string
Title:
Status
Maximum Length:30
The member card status code which shows values based on ORA_LOY_MEM_CARD_STATUS. There is no default value or limitation associated with this attribute. -
TierName: string
Title:
Tier Name
Read Only:true
The tier name specifies the member???s tier, for the member to whom the membership card is issued. There is no default value, dependency, or limitation associated with this attribute. -
UpdateFlag: boolean
Read Only:
true
Default Value:true
The flag which indicates integrating user whether current row of information is updatable or not. This is an Oracle Sales Cloud wide field and is a required field for the REST API. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyMembers-groupMembers-item-response
Type:
Show Source
object
-
AssociationEndDate: string
(date)
Title:
Association End Date
The association end date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute. -
AssociationStartDate: string
(date)
Title:
Association Start Date
The association start date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute. -
GroupMemberName: string
Title:
Group Member Name
Read Only:true
Maximum Length:100
The group member name of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
GroupMemberNumber: string
Title:
Group Member Public Unique ID
Read Only:true
Maximum Length:30
The group member number of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberAssociationId: integer
(int64)
Title:
Member Association ID
The member association identifier of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberAssociationPUID: string
Title:
Member Association Public Unique ID
The public unique identifier of the member association identifier of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberAssociationType: string
Title:
Member Association Type
Read Only:true
Maximum Length:30
Default Value:ORA_MEM_TYPE_INDIVIDUAL
The member association type of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberName: string
Title:
Member Name
Read Only:true
Maximum Length:100
The member name of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
Read Only:true
Maximum Length:30
The member number of the corporate member. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyMembers-individualMembers-item-response
Type:
Show Source
object
-
AssociationEndDate: string
(date)
Title:
Association End Date
The association end date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute. -
AssociationStartDate: string
(date)
Title:
Association Start Date
The association start date of the corporate member association. There is no default value, dependency, or limitation associated with this attribute. -
GroupMemberName: string
Title:
Group Member Name
Read Only:true
Maximum Length:100
The group member name of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
GroupMemberNumber: string
Title:
Group Member Public Unique ID
Read Only:true
Maximum Length:30
The group member number of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberAssociationId: integer
(int64)
Title:
Member Association ID
The member association identifier of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberAssociationPUID: string
Title:
Member Association Public Unique ID
The public unique identifier of the member association identifier of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberAssociationType: string
Title:
Member Association Type
Read Only:true
Maximum Length:30
Default Value:ORA_MEM_TYPE_INDIVIDUAL
The member association type of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberName: string
Title:
Member Name
Read Only:true
Maximum Length:100
The member name of the corporate member. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
Read Only:true
Maximum Length:30
The member number of the corporate member. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyMembers-MemberAttributes-item-response
Type:
Show Source
object
-
AttribDefnId: integer
(int64)
Title:
Attribute Definition ID
The attribute definition identifier of the member attribute. This is the identifier for the point type definition. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Created On
Read Only:true
The date when the member attribute was created. Oracle Loyalty Cloud generates this attribute value during the creation of a new member attribute. There is no default value, dependency, or limitation associated with this attribute. -
DescText: string
Title:
Description
Read Only:true
Maximum Length:1000
The description which gives information about the member attribute. There is no default value, dependency, or limitation associated with this attribute. -
DisplayName: string
Title:
Attribute Name
Read Only:true
Maximum Length:30
The display name of the member attribute definition. There is no default value , dependency or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Updated On
Read Only:true
The date when the voucher was last updated. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the member attribute There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyAttrdefnBId: integer
(int64)
Read Only:
true
The attribute definition identifier of the member attribute. This is the identifier for point type definition. There is no default value, dependency, or limitation associated with this attribute. -
LoyAttribId: integer
(int64)
Title:
Loyalty Attribute ID
The primary key of the member attribute object. Oracle Loyalty Cloud generates this attribute value during the creation of a new member attribute. There is no default value, dependency, or limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member ID
The member identifier to which this member attribute belongs. There is no default value, dependency, or limitation associated with this attribute. -
ProgramId: integer
(int64)
Read Only:
true
The program unique identifier which this member attribute is associated with. There is no default value, dependency, or limitation associated with this attribute. -
PromotionId: integer
(int64)
Read Only:
true
The promotion unique identifier which this member attribute is associated with. There is no default value, dependency, or limitation associated with this attribute. -
Value: string
Title:
Value
Maximum Length:250
The member attribute value after the Oracle Loyalty Cloud engine updates the member-level attribute value based on bucket processing or by applying loyalty promotions that updates the value of attribute. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyMembers-MemberContact-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user that creates the contact record. Oracle Loyalty Cloud populates this value when the loyalty administrator creates the contact in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Created Date
Read Only:true
The date when the contact record is created. Oracle Loyalty Cloud sets this date value when the loyalty administrator creates the contact in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
DateOfBirth: string
(date)
Title:
Date of Birth
Read Only:true
The date when the member contact was born. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date of the last update of the contact record. Oracle Loyalty Cloud updates this attribute for the logged date when the loyalty administrator updates the details about the contact in the UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Changed By
Read Only:true
Maximum Length:64
The date of the last update of the contact record by the user. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the contact in the UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The contact record that was last updated by the user login. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the contact in the UI. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyMemConId: integer
(int64)
Title:
Loyalty Member Contact ID
The member contact identifier. The primary Identifier for referring a Oracle Sales Cloud contact that is enrolled as a loyalty member in a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PersonFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the member contact. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same FirstName attribute can be used while enrolling a loyalty member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PersonId: integer
(int64)
The member contact person identifier, which is the person identifier from the Oracle Sales Cloud Partner object. There is no default value, dependency, or limitation associated with this attribute.
-
PersonLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the member contact. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same LastName attribute can be used while enrolling a loyalty member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyMembers-MemberReferrals-item-response
Type:
Show Source
object
-
AccntId: integer
(int64)
Title:
Account ID
The account identifier for the member's partner object of the member referred by current member. If the MemberType attribute is set to Company, then Oracle Loyalty Cloud populates AccountId. This attribute depends on the value of the MemberType attribute. There is no default value or limitation with this attribute. -
AccountPartyNumber: string
Title:
Account Party Number
Read Only:true
Maximum Length:30
The account party number associated with the referred member. There is no default value, dependency, or limitation associated with this attribute. -
AccountTypeCode: string
Title:
Account Type Code
Read Only:true
Maximum Length:30
Default Value:ZCA_PROSPECT
The lookup type code of an account. The lookup type value is ZCA_ACCOUNT_TYPE. There is no default value or limitation associated with this attribute. -
AccrualLookupCode: string
Title:
Accrual Lookup Code
Read Only:true
Maximum Length:30
The accrual lookup code is a read-only attribute that is dependent on AccrualLookupType. This attribute shows information about the referred member. This attribute gives additional information regarding AccrualTypeCode as a lookup code. There is no default value or limitation associated with this attribute. -
AccrualLookupType: string
Title:
Accrual Lookup Type
Read Only:true
Maximum Length:30
The accrual lookup type attribute is a read-only attribute that shows information about the lookup type that is used to display AccrualTypeCode. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
AccrualMeaning: string
Title:
Accrual Type Meaning
Read Only:true
Maximum Length:80
The accrual meaning is a read-only attribute that shows information about the meaning text of the AccrualTypeCode attribute. This attribute shows information about the referred member. This attribute is dependent on AccrualTypeCode. There is no default value or limitation associated with this attribute. -
AccrualStartDate: string
(date-time)
Title:
Accrual Start Date
The date when the member starts accruing points from another member. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
AccrualToHousehold: string
Title:
Accrual to Household Member
Read Only:true
Maximum Length:100
The household to which an Individual member's points can be accrued. There is no default value, dependency, or limitation associated with this attribute. -
AccrualToHouseholdFlag: string
Title:
Accrual to Household
This flag determines whether the accrual due to a transaction completed by a household member should be accrued to a member or to the household to which it belongs. There is no default value associated with this attribute. -
AccrualToMemId: integer
(int64)
Title:
Accrual-to Member ID
The identifier of the member to whose account the points are accrued for a corporate accrual. This attribute shows information about the referred member. This attribute value depends on the AccrualType attribute. There is no default value or limitation associated with this attribute. -
AccrualTypeCode: string
Title:
Accrual Type
Maximum Length:30
The accrual type value, that is an LOV attribute which is based on FND lookups. This attribute shows information about the referred member. For the possible input values of AccrualTypeCode, the integrating user must first invoke the corresponding LOV resource path URL. For example: invoke lovResourcepath ../crmRestApi/resources/11.12.0.0/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_ACCRU_TYPE. There is no default value, dependency, or limitation associated with this attribute. -
AddressLineOne: string
Title:
Individual Address Line 1
Read Only:true
Maximum Length:240
The first line in the address provided by a member contact or account while enrolling. There is no default value, dependency, or limitation associated with this attribute. -
AddressLineThree: string
Title:
Individual Address Line 3
Read Only:true
Maximum Length:240
The third line in the address provided by a member contact or account while enrolling. There is no default value, dependency, or limitation associated with this attribute. -
AddressLineTwo: string
Title:
Individual Address Line 2
Read Only:true
Maximum Length:240
The second line in the address provided by a member contact or account while enrolling. There is no default value, dependency, or limitation associated with this attribute. -
City: string
Title:
Individual City
Read Only:true
Maximum Length:60
The city of the contact or account or household, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ContactDateOfBirth: string
(date)
Title:
Date of Birth
Read Only:true
The date when the member was born. This attribute shows information from the corresponding contact used to create the current loyalty member. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the member contact. A single Oracle Sales Cloud contact can be used to enroll into different loyalty programs. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactId: integer
(int64)
Title:
Contact ID
The contact identifier as specified in the Member Contacts object. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the member contact. A single Oracle Sales Cloud contact can be used to enroll into different loyalty programs. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactName: string
Title:
Contact
Maximum Length:450
The name of the contact associated with the member. This attribute shows information about the referred member. This attribute has the format of ContactFirstName ContactLastName. There is no default value, dependency, or limitation associated with this attribute. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The currency code used by the corporation. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CorpMemberNumber: string
Title:
Corporation Member Number
Maximum Length:15
The corporate member number. If the current member is part of the company or corporate account, then Oracle Loyalty Cloud populates this field. This is an optional attribute which is introduced for future use. Oracle Loyalty Cloud does not currently use this attribute. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
Country: string
Title:
Individual Country
Read Only:true
Maximum Length:2
The country of the contact or account or household, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
County: string
Title:
Individual County
Read Only:true
Maximum Length:60
The county of the contact or account or household address, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user that creates the member record. Oracle Loyalty Cloud populates this value when the loyalty administrator creates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Created Date
Read Only:true
The date when the member record is created. Oracle Loyalty Cloud sets this date value when the loyalty administrator creates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
CreationSource: string
Title:
Creation Source
The information detailing the member creation source. This attribute value is set while creating a member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate method that is applied. This rate can apply to an individual or throughout the corporation. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The international currency code used by the loyalty member to complete transactions. International codes such as USD, INR,GBP are valid for this attribute. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyDate: string
(date)
Title:
Currency Date
The date when the currency conversion rate is applied for a given currency code. There is no default value, dependency, or limitation associated with this attribute. -
DateOfBirth: string
(date)
Title:
Date of Birth
Read Only:true
The date when the member was born. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the member. This attribute shows the read-only value of member's email address. While creating a loyalty member under a program, the MemberEmailAddress attribute gets written to the Contact information, which is used to recognize the contact. There is no default value, dependency, or limitation associated with this attribute. -
EnrollFlag: string
Title:
Enrollment Required
The Enroll flag is set when importing a member from a different system to an existing loyalty system. There is no default value or limitation associated with this attribute. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the member. This is one of the Member Contact fields which can be used while enrolling a loyalty member in a program. There is no default value, dependency, or limitation associated with this attribute. -
GroupLookupCode: string
Title:
Group Lookup Code
Read Only:true
Maximum Length:30
The FND lookup code value of the Member Group code. ORA_LOY_MEM_GRP is the lookup type for the Member Travel group. This attribute is dependent on the GroupLookupType attribute. There is no default value or limitation associated with this attribute. -
GroupLookupType: string
Title:
Group Lookup Type
Read Only:true
Maximum Length:30
The FND lookup type value of the Member Group code. ORA_LOY_MEM_GRP is the lookup type for the Member Travel group. There is no default value, dependency, or limitation associated with this attribute. -
GroupMeaning: string
Title:
Member Group Meaning
Read Only:true
Maximum Length:80
The meaning of the current group that the referred loyalty member is in. This has an extended lookup associated with ORA_LOY_MEM_GRP, which is the lookup type for the Member Travel group. This attribute is dependent on the GroupLookupType attribute. There is no default value or limitation associated with this attribute. -
HHAddressOne: string
Title:
Household Address Line 1
Read Only:true
Maximum Length:240
Address entered in line one of a Household. -
HHAddressThree: string
Title:
Household Address Line 3
Read Only:true
Maximum Length:240
Address entered in line three of a Household. -
HHAddressTwo: string
Title:
Household Address Line 2
Read Only:true
Maximum Length:240
Address entered in line two of a Household. -
HHCity: string
Title:
Household City
Read Only:true
Maximum Length:60
City of a Household. -
HHCountry: string
Title:
Household Country
Read Only:true
Maximum Length:2
Country of a Household. -
HHCounty: string
Title:
Household County
Read Only:true
Maximum Length:60
County of a Household. -
HHPostalCode: string
Title:
Household Postal Code
Read Only:true
Maximum Length:60
Postal Code of a Household. -
HHProvince: string
Title:
Household Province
Read Only:true
Maximum Length:60
Province of a Household. -
HHState: string
Title:
Household State
Read Only:true
Maximum Length:60
State of a Household. -
HouseholdMemberNumber: string
Title:
Household Member Number
The member number of a household to be passed by a payload. This value should be a valid household enrolled already in the same loyalty program. There is no default value associated with this attribute. -
JobTitle: string
Title:
Job Title
The job title of a contact which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
LastAccrTransactionDt: string
(date-time)
Title:
Last Accrual Transaction Date
The date when the last accrual transaction for the loyalty member has occurred. There is no default value, dependency, or limitation associated with this attribute. -
LastRdmTransactionDt: string
(date-time)
Title:
Last Redemption Transaction Date
The last redemption transaction date. This attribute shows when the last redemption transaction by the member has occurred. There is no default value, dependency, or limitation associated with this attribute. -
LastTransactionProcedDt: string
(date-time)
Title:
Last Transaction Processed Date
The last transaction process date. This date shows when the last transaction was performed by the loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Change Date
Read Only:true
The date when the member record is updated. Oracle Loyalty Cloud sets this date value when the loyalty administrator updates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Changed By
Read Only:true
Maximum Length:64
The user that updates the member record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of user that updated the member record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeAVal: number
Title:
Lifetime Payment Type A Value
The member's life time point balance in internal point type A. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeBVal: number
Title:
Lifetime Payment Type B Value
The member's life time point balance in internal point type B. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeCVal: number
Title:
Lifetime Payment Type C Value
The member's life time point balance in internal point type C. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeDVal: number
Title:
Lifetime Payment Type D Value
The member's life time point balance in internal point type D. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeEVal: number
Title:
Lifetime Payment Type E Value
The member's life time point balance in internal point type E. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeFVal: number
Title:
Lifetime Payment Type F Value
The member's life time point balance in internal point type F. A program can have up to eight point types, internally referred to as Point type (A to H). Each of the point type has a life time point balance associated with it which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeGVal: number
Title:
Lifetime Payment Type G Value
The member's life time point balance in internal point type G. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeHVal: number
Title:
Lifetime Payment Type H Value
The member's life time point balance in internal point type H. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyAccountName: string
Title:
Account Name
The loyalty member account name for the member's partner object. If the MemberTypeCode attribute is Company, then Oracle Loyalty Cloud populates the account name. This attribute depends on the value of the MemberTypeCode attribute. Oracle Loyalty Cloud populates the AccountName attribute based on the AccountId attribute. There is no default value or limitation associated with this attribute. -
LoyHouseholdName: string
Title:
Household Name
The household member name. If the MemberTypeCode attribute is set to Household, then this attribute shows membership information about the referred household. There is no default value, dependency, or limitation associated with this attribute. -
LoyMemberId: integer
(int64)
Title:
Loyalty Member ID
The primary key of member referred by current loyMember resource. There is no default value, dependency, or limitation associated with this attribute. -
LoyProgramName: string
Title:
Program Name
The name of the loyalty program in which the member has been enrolled. This is a read-only attribute for the read-only child resource MemberReferrals of loyMembers. The LoyProgramName attribute is provided as input while creating the loyalty member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
LstTierChangeDt: string
(date-time)
Title:
Date of Member's Last Tier Change
The date when the member's tier change occurs. Oracle Loyalty Cloud updates this date when a member's tier changes. There is no default value, dependency, or limitation associated with this attribute. -
MemberClassCode: string
Title:
Member Class
Maximum Length:30
The FND lookup code value of Member Class as an input of loyalty Members. The possible input values can be obtained by invoking the corresponding lovResourcePath URL: fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_CLASS. -
MemberClassMeaning: string
Title:
Member Class Meaning
Read Only:true
Maximum Length:80
The current class of the loyalty member. This is an extended lookup type attribute of type ORA_LOY_MEM_CLASS. There is no default value, dependency, or limitation associated with this attribute. -
MemberEmailAddress: string
Title:
Member Email Address
Read Only:true
Maximum Length:320
The member's email address, which is provided as a input while creating loyalty Member record through REST API. This value will be used to create an Oracle Sales Cloud contact behind the scenes. There is no default value, dependency, or limitation associated with this attribute. -
MemberGrpCode: string
Title:
Member Group
Maximum Length:30
The extended Lookup Type attribute of type ORA_LOY_MEM_GRP which shows information about the member's current group. There is no default value, dependency, or limitation associated with this attribute. -
MemberName: string
Title:
Member Name
Maximum Length:100
The name of the referred loyalty member, which can be provided as input while creating a loyalty member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
Maximum Length:30
The member number of the referred loyalty member. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute. -
MemberPhaseCode: string
Title:
Member Phase
Maximum Length:30
The lookup code value of the member phase used as a an input for loyalty Members. The integrating user must first invoke the lovResourcepath URL for possible input values. The corresponding lovResourcePath URL is ?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_PHASE. There is no default value, dependency, or limitation associated with this attribute. -
MemberPhaseMeaning: string
Title:
Member Phase Meaning
Read Only:true
Maximum Length:80
The current phase for the that the loyalty member. This attribute has an extended lookup associated with ORA_LOY_MEM_PHASE. There is no default value, dependency, or limitation associated with this attribute. -
MembershipSchemeId: integer
(int64)
Title:
Membership Scheme ID
The unique reference to the member scheme, if any, chosen by the user while enrolling into the loyalty program. The member scheme can be a paid or free scheme. For example, a 6 months free membership, or a 1 Year $5 paid membership, and so on. There is no default value, dependency, or limitation associated with this attribute. -
MemberTypeCode: string
Title:
Type
Maximum Length:30
Default Value:ORA_MEM_TYPE_INDIVIDUAL
The member type, which is provided as an input attribute while creating a loyalty member. To know the possible input values, the user must invoke the corresponding lovResourcePath URL ....fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_TYPE. There is no default value, dependency, or limitation associated with this attribute. -
MemberTypeMeaning: string
Title:
Member Type Meaning
Read Only:true
Maximum Length:80
The meaning of the current type that the referred loyalty member is in. This has an extended lookup associated with ORA_LOY_MEM_TYPE, which is the lookup type for the Member Travel group. This attribute is dependent on the MemberLookupType attribute. There is no default value or limitation associated with this attribute. -
MobileNumber: string
Title:
Mobile Number
Read Only:true
Maximum Length:40
The mobile number of the member. This attribute can be provided as input when enrolling a loyalty member into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationAddressOne: string
Title:
Company Address Line 1
Read Only:true
Maximum Length:240
Address of a Account entered in line One. -
OrganizationAddressThree: string
Title:
Company Address Line 3
Read Only:true
Maximum Length:240
The third line of the address provided while enrolling a member as an organization in a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationAddressTwo: string
Title:
Company Address Line 2
Read Only:true
Maximum Length:240
Address of an Account entered in line two. -
OrganizationCity: string
Title:
Company City
Read Only:true
Maximum Length:60
The city part of the address provided by an organization while enrolling a member as an organization in loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationCountry: string
Title:
Company Country
Read Only:true
Maximum Length:2
Country of an Account. -
OrganizationCounty: string
Title:
Company County
Read Only:true
Maximum Length:60
County of an Account. -
OrganizationPostalCode: string
Title:
Company Postal Code
Read Only:true
Maximum Length:60
Postal Code of an Account. -
OrganizationProvince: string
Title:
Company Province
Read Only:true
Maximum Length:60
Province of an Account. -
OrganizationState: string
Title:
Company State
Read Only:true
Maximum Length:60
State of an Account. -
OrgGroupId: integer
(int64)
Title:
Organization Group ID
The organization group identifier to which the loyalty member belongs. There is no default value, dependency, or limitation associated with this attribute. -
OrgGroupPartyNumber: string
Title:
Household Party Number
Read Only:true
Maximum Length:30
The organization group party number associated with the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ParentMember: string
Title:
Parent
Maximum Length:1
Default Value:N
The parent member where the loyalty member is either a household or an individual, but is also a corporate member. There is no default value, dependency, or limitation associated with this attribute. -
PartyName: string
Title:
Contact Party Name
Maximum Length:360
The loyalty partner name as an alternative identifier. Oracle Loyalty Cloud creates this identifier when a loyalty membership is created through a partner as a reference. There is no default value, dependency, or limitation associated with this attribute. -
PartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The party number of the contact associated with the loyalty member. -
PersonFirstName: string
Title:
Primary Contact First Name
Read Only:true
Maximum Length:150
The first name of the member contact in the context of referred member. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same FirstName attribute can be used while enrolling a loyalty member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PersonLastName: string
Title:
Primary Contact Last Name
Read Only:true
Maximum Length:150
The last name of the member contact in the context of the referred member. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same LastName attribute can be used while enrolling a loyalty member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PersonName: string
Title:
Person Name
Maximum Length:450
The full name of the member contact. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same LastName attribute can be used while enrolling a member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:40
The phone number of the member. This is one of the Member Contact fields which can be used while enrolling a loyalty member in a program. There is no default value, dependency, or limitation associated with this attribute. -
Points: string
Title:
Points
Read Only:true
Maximum Length:255
Default Value:0
The point balance. This attribute is the numeric value of the point balance of the loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeAVal: number
Title:
Point Type A Value
Default Value:0
The points for the member from Point Type A as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeBVal: number
Title:
Point Type B Value
Default Value:0
The points for the member from Point Type B as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeCVal: number
Title:
Point Type C Value
Default Value:0
The points for the member from Point Type C as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeDVal: number
Title:
Point Type D Value
Default Value:0
The points for the member from Point Type D as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeEVal: number
Title:
Point Type E Value
Default Value:0
The points for the member from Point Type E as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeFVal: number
Title:
Point Type F Value
Default Value:0
The points for the member from Point Type F as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeGVal: number
Title:
Point Type G Value
Default Value:0
The points for the member from Point Type G as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeHVal: number
Title:
Point Type H Value
Default Value:0
The points for the member from Point Type H as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PostalCode: string
Title:
Individual Postal Code
Read Only:true
Maximum Length:60
The postal code of the contact or account or household address, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PrConId: integer
(int64)
Title:
Primary Contact ID
The partner contact identifier. This value can be provided as an input while creating a loyalty member through the resource and when Oracle Loyalty Cloud enrols the corresponding contact as a member in the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PreviousTierName: string
Title:
Previous Tier Name
Read Only:true
The previous tier name from which the loyalty member is promoted to the current tier. There is no default value, dependency, or limitation associated with this attribute. -
ProgramNumber: string
Title:
Program Number
Maximum Length:30
The program number associated with the referred member. There is no default value, dependency, or limitation associated with this attribute. -
Province: string
Title:
Individual Province
Read Only:true
Maximum Length:60
The province of the contact or account or household, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
RealTimeBonusFlag: boolean
Title:
Real Time Bonus
Maximum Length:1
Default Value:false
The real time bonus flag. If this flag is set to Y, then on member enrollment, it processes enrollment and referral bonus transactions in real time. Otherwise, it will create an enrollment bonus and referral bonus transaction and set the status to Queued for the batch engine to pick and process. There is no default value, dependency, or limitation associated with this attribute. -
ReferConId: integer
(int64)
Title:
Referring Member Contact ID
Read Only:true
The primary contact identifier of referral member. This value is shown as additional information regarding the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByNam: string
Title:
Referred By
Maximum Length:100
The member identifier of the referring member name who has referred the current member to the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByName: string
Title:
Referred By
The member identifier by name who has referred the current member to the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByNumber: string
Title:
Referred by Number
Maximum Length:30
The member number of the member who has referred the current member to the loyalty program. This value is input by the user and is validated against the existing member record in Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
RelationshipId: integer
(int64)
Title:
Relationship ID
The relationship identifier which shows the relationship between loyalty members. There is no default value, dependency, or limitation associated with this attribute. -
RelationshipRecId: integer
(int64)
Title:
Relationship Record Identifier
Read Only:true
The relationship record identifier that shows the relationship of the member between other loyalty members. For example, there might be a relationship between an organization and a member. There is no default value, dependency, or limitation associated with this attribute. -
RelationshipType: string
Title:
Relationship Type
Read Only:true
Maximum Length:30
The relationship type showing the type of relation between loyalty members. For example, there might be a relationship between an organization and a member. There is no default value, dependency, or limitation associated with this attribute. -
reltype: string
Title:
Relationship Type
The relationship type showing the type of relation between loyalty members. For example, there might be a relationship between an organization and a member. There is no default value, dependency, or limitation associated with this attribute. -
StartDate: string
(date-time)
Title:
Joining Date
The date when the membership in the loyalty program starts. There is no default value, dependency, or limitation associated with this attribute. -
State: string
Title:
State
Read Only:true
Maximum Length:60
The state code of the contact or account or household, which is provided by member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
Status: string
Title:
Status Meaning
Maximum Length:80
The member status meaning of referred loyalty member which is a read-only value based on the Status code attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_STATUS lookup. There is no default value or limitation associated with this attribute. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:ORA_MEM_STATUS_ACTIVE
The status code of the loyalty member, which is a read-only value based on the Status attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_STATUS lookup. There is no default value or limitation associated with this attribute. -
SuppressCall: string
Title:
Suppress Call
The attribute indicates that the member does not want to receive any calls pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressCallFlag: boolean
Title:
Block Member Call Contact
Maximum Length:1
Default Value:false
Block Member Call Contact. -
SuppressEmail: string
Title:
Suppress Email
The attribute indicates that the member does not want to receive any mail pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressEmailFlag: boolean
Title:
Block Member Email Contact
Maximum Length:1
Default Value:false
Block Member Email Contact. -
SuppressFax: string
Title:
Suppress Fax
The attribute indicates that the member does not want to receive any fax pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressFaxFlag: boolean
Title:
Block Member Fax Contact
Maximum Length:1
Default Value:false
Block Member Fax Contact. -
SuppressMail: string
Title:
Suppress Mail
The attribute indicates that the member does not want to receive any mail pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressMailFlag: boolean
Title:
Block Member Mail Contact
Maximum Length:1
Default Value:false
Block Member Mail Contact. -
SuppressSMS: string
Title:
Suppress SMS
The attribute indicates that the member does not want to receive any SMS pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressSMSFlag: boolean
Title:
Block Member SMS Contact
Maximum Length:1
Default Value:false
Block Member SMS Contact. -
SurvMemNumber: string
Title:
Surviving Member Number
Maximum Length:30
The surviving member number associated with the referred member. There is no default value, dependency, or limitation associated with this attribute. -
TierName: string
Title:
Tier
Read Only:true
Maximum Length:255
The tier name of the current tier of the loyalty member. The tier calculation is done by the Oracle Loyalty Cloud engine. This attribute value is set by the Oracle Loyalty Cloud engine when performing the tier assessment of the loyalty member based on the qualifying point balance of the member. There is no default value, dependency, or limitation associated with this attribute. -
URL: string
The member URL which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute.
-
ValLifeScore: string
Title:
Lifetime Value Score
Maximum Length:50
The life time value score of the loyalty member as the highest watermark value. There is no default value, dependency, or limitation associated with this attribute. -
WorkPhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:40
The work phone number of the referred member. The WorkPhoneNumber attribute is another contact related attribute which shows the secondary formatted phone number if the primary phone number Is not available. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyMembers-MemberTier-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
The Active flag represents whether the tier which is active among all the member tier records. For example a member might be promoted from a silver to gold tier. There will be two records, one for silver and another for gold but the record with gold tier is marked as active which means the member currently belongs to the gold tier. The default value is N, but there is no dependency, or limitation associated with this attribute. -
Comments: string
Title:
Reason for Change
Maximum Length:250
The comments provided by the Loyalty Engine while changing the member tier. There is no default value, dependency, or limitation associated with this attribute. -
CreatedBy: string
Title:
Changed By
Read Only:true
Maximum Length:64
The user identifier of the user that made the change to the current member tier represented by this record. There is no default value, dependency, or limitation associated with this attribute. -
EndDt: string
(date-time)
Title:
End Date
The date when the member tier ends. The loyalty member is active in a particular member tier until this date. There is no default value, dependency, or limitation associated with this attribute. -
FromTierName: string
Title:
Tier Name
Read Only:true
Maximum Length:30
The previous tier name from which the loyalty member is promoted to the current tier. There is no default value, dependency, or limitation associated with this attribute. -
FromTierStartDate: string
(date)
Title:
From Tier Start Date
The tier start date of the current tier. There is no default value, dependency, or limitation associated with this attribute. -
FutrTierName: string
Title:
Tier Name
Read Only:true
Maximum Length:30
The next immediate tier name for the member to upgrade. There is no default value, dependency, or limitation associated with this attribute. -
FutrTierStampDt: string
(date)
Title:
Future Tier Date
The Stamp Future Tier attribute flags the future tier assessment date details if it is likely that a member will be downgraded or requalified based on the Tier Effective Period End Date. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Change Date
Read Only:true
The member tier record last update date. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the member tier in the UI. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
The Lookup Code attribute shows additional information for the reason for the change to the member tier. The corresponding lookupType is ORA_LOY_TIER_CHANGE_REASON. This attribute is dependent on LookupType. This attribute does not have a default value. -
LookupType: string
Title:
Lookup Type
Read Only:true
Maximum Length:30
The lookup type corresponding to the Reason for Change value of the member tier change. The lookup type value is ORA_LOY_TIER_CHANGE_REASON. There is no default value, dependency, or limitation associated with this attribute. -
LoyTierClsId: integer
(int64)
Title:
Loyalty Tier Class ID
Read Only:true
The tier class identifier of a member tier, which is a reference identifier that uniquely identifies a member tier class. It provides information about which tier class the current member tier record belongs. There is no default value, dependency, or limitation associated with this attribute. -
LoyTierId: integer
(int64)
Title:
Loyalty Tier ID
Read Only:true
The tier identifier of the member tier which uniquely identifies a loyalty tier. For example, if a member currently belongs to the Silver tier, then to identify the Silver tier, Oracle Loyalty Cloud uses the LoyTierId attribute as an internal Identifier. There is no default value, dependency, or limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member ID
The member reference identifier for the current member tier child records, which provides information about the current member tier to which the member belongs. There is no default value, dependency, or limitation associated with this attribute. -
MemTierId: integer
(int64)
Title:
Member Tier ID
The member tier identifier, which is an internal identifier for the member tier for which the member tier record exists. For example, if the member has a current tier of Silver, then the record in the Member Tier object has an entry for MemberId with MemberTierid as the unique identifier. There is no default value, dependency, or limitation associated with this attribute. -
MemTierNum: string
Title:
Member Tier Number
Maximum Length:30
The unique identifier which shows the number of the tier to which the loyalty member belongs. There is no default value, dependency, or limitation associated with this attribute. -
NextAssessDt: string
(date)
Title:
Next Tier Assessment Date
The date on which the next tier assessment occurs for the member. There is no default value, dependency, or limitation associated with this attribute. -
NextTierName: string
Read Only:
true
The possible tier name to which the member can upgrade, while considering the number of qualifying points that are required to achieve that tier. There is no default value, dependency, or limitation associated with this attribute. -
OrigEndDt: string
(date-time)
Title:
Original Tier End Date
The system-generated tier end date for the tier record. There is no default value, dependency, or limitation associated with this attribute. -
OverrideDt: string
(date)
Title:
Override Date
The date on which a tier change occurs and overrides the tier end date. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeAVal: number
Title:
Point Type A Value
The points for the member from Point Type A as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeBVal: number
Title:
Point Type B Value
The points for the member from Point Type B as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeCVal: number
Title:
Point Type C Value
The points for the member from Point Type C as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeDVal: number
Title:
Point Type D Value
The points for the member from Point Type D as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeEVal: number
Title:
Point Type E Value
The points for the member from Point Type E as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeFVal: number
Title:
Point Type F Value
The points for the member from Point Type F as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeGVal: number
Title:
Point Type G Value
The points for the member from Point Type G as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeHVal: number
Title:
Point Type H Value
The points for the member from Point Type H as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PresentQualPoints: number
Read Only:
true
The present qualifying point balance for the member. Oracle Loyalty Cloud calculates this attribute value based on a loyalty member's point balance. This attribute provides information about the current balance. There is no default value, dependency, or limitation associated with this attribute. -
ProcessedDt: string
(date)
Title:
Processed Date
The date when the member tier is processed. When the Oracle Loyalty Cloud engine initiates tier processing, it sets the date when it updates the tier. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingComment: string
Title:
Processing Comment
Maximum Length:1000
The tier processing comment that provides the details of an error, if any occurred, during tier processing. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingLog: string
Title:
Processing Log
Maximum Length:1000
The tier processing log that provides the details of all the promotions that are applied. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingStatCode: string
Title:
Processing Status
Maximum Length:30
The tier processing status code that provides the details of all the promotions that are applied. There is no default value, dependency, or limitation associated with this attribute. -
ProgramName: string
Title:
Program
Read Only:true
Maximum Length:50
The name of the loyalty program in which the current loyalty member is enrolled. There is no default value, dependency, or limitation associated with this attribute. -
PromotionName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the promotion that has been applied and for which the tier is created. There is no default value, dependency, or limitation associated with this attribute. -
QualEndDate: string
(date-time)
Title:
Qualifying End Date
The qualifying end date of the member tier. There is no default value, dependency, or limitation associated with this attribute. -
QualFlag: boolean
Title:
Qualifying
Maximum Length:1
The flag that indicates the points are of type qualifying points. There is no default value, dependency, or limitation associated with this attribute. -
QualPointsToUpgrade: number
Read Only:
true
The qualifying points required to upgrade to the next tier. For example, consider that the present qualifying balance for the loyalty member is 100 points and the current tier is Silver, and to upgrade to the Gold tier, the member requires another 50 points. In this example, the QualPointsToUpgrade attribute is 50. There is no default value, dependency, or limitation associated with this attribute. -
QualStartDate: string
(date-time)
Title:
Qualifying Start Date
The qualifying start date of the member tier. There is no default value, dependency, or limitation associated with this attribute. -
ReasonValue: string
Title:
Reason for Change Meaning
Maximum Length:80
The reason for the change of the member tier. The attribute gets its value when the Oracle Loyally Cloud engine initiates the tier processing. This attribute shows the reason why particular loyalty members get their tiers changed. There is no default value, dependency, or limitation associated with this attribute. -
StartDt: string
(date-time)
Title:
Start Date
The date when the member tier starts. For example, if the loyalty member's current tier is Silver and previously the tier was Bronze, then the Bronze tier has a start date and an end date which signifies the time period that the loyalty member belonged to that particular tier. There is no default value, dependency, or limitation associated with this attribute. -
StartQualPd: string
Title:
Meaning
Read Only:true
Maximum Length:80
The LOV Meaning of the LOV Code 'StaryQualPdCode'. The lookup code value of the loyalty tier assessment model that is used to change this tier. There is no dependency or limitation associated with this attribute. -
StartQualPdCode: string
Title:
Start Qualifying Period
Read Only:true
Maximum Length:30
Default Value:ORA_TR_MODEL_NONE
The lookup code value of loyalty tier assessment model used to change this tier. The default value is ORA_TR_MODEL_NONE. There is no dependency or limitation associated with this attribute. -
TierClassId: integer
(int64)
Title:
Tier Class ID
The tier class identifier of a member tier, which is a reference identifier that uniquely identifies a member tier class. It provides information about which tier class the current member tier record belongs. There is no default value, dependency, or limitation associated with this attribute. -
TierClassName: string
Title:
Tier Class
Read Only:true
Maximum Length:30
The tier class name. For each tier to which the member belongs in the Loyalty Member tier records, there is a corresponding tier class name which categorizes the tiers in a loyalty system. There is no default value, dependency, or limitation associated with this attribute. -
TierId: integer
(int64)
Title:
Tier ID
The tier identifier of the member tier which is the unique identifier to identify a loyalty tier. For example, if a member currently belongs to the Silver tier, then to identify the Silver tier, Oracle Loyalty Cloud uses the LoyTierId attribute as an internal Identifier. There is no default value, dependency, or limitation associated with this attribute. -
TierName: string
Title:
Tier
Maximum Length:30
The tier name to which the member currently belongs. There is no default value, dependency, or limitation associated with this attribute. -
TierQualPoints: number
Read Only:
true
The present qualifying point balance for the member. Oracle Loyalty Cloud calculates this attribute value based on a loyalty member's point balance. This attribute provides information about the current balance. There is no default value, dependency, or limitation associated with this attribute. -
TillDate: string
(date)
Read Only:
true
The date to when the qualifying points need to be accrued, in order to attain the current tier. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyMembers-MemberTransactions-item-response
Type:
Show Source
object
-
AccItmList: string
Title:
Accrual Item List
Read Only:true
Maximum Length:255
The list of accrual items that were accrued due to the processing of transactions. There is no default value or limitation associated with this attribute. -
AccrualDisputedTransactionNumber: string
Title:
Disputed Transaction
The attribute indicates the transaction number of the accrual transaction which was incorrectly created. There is no default value, dependency or limitation associated with this attribute. -
AccrualDisputeStatus: string
Title:
Accrual Dispute Status Meaning
Read Only:true
Maximum Length:80
The list of value meaning for the Accrual Dispute Status. There can be missing or incorrect accrual based on a reported dispute. There is no default value or limitation associated with this attribute. -
AccrualDisputeStatusCode: string
Title:
Accrual Dispute Status
Maximum Length:30
The attribute specifies the status of the created accrual dispute, that is, whether the accrual dispute created is approved or rejected. The accepted values are ORA_ACRL_DISPUTE_STAT_APPR and ORA_ACRL_DISPUTE_STAT_REJ. There is no default value, dependency, or limitation associated with this attribute. -
AccrualDisputeType: string
Title:
Accrual Dispute Type Meaning
Read Only:true
Maximum Length:80
The list of value meaning for the Accrual Dispute Type. It can be either a missing or incorrect accrual. There is no default value or limitation associated with this attribute. -
AccrualDisputeTypeCode: string
Title:
Accrual Dispute Type
Maximum Length:30
The attribute specifies the type of accrual dispute that is created. Accepted values are ORA_ACRL_DISPUTE_TYPE_INCOR and ORA_ACRL_DISPUTE_TYPE_MISSING. There is no default value, dependency, or limitation associated with this attribute. -
ActivityDate: string
(date-time)
Title:
Activity Date
The date when a transaction activity occurs. The transaction can be an accrual or redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
ActivityDay: number
Title:
Activity Day
The transaction activity day. This attribute represents the day when an accrual or redemption activity occurs. There is no default value, dependency, or limitation associated with this attribute. -
ActivityHour: number
Title:
Activity Hour
The transaction activity hour. This attribute represents the time in hours when an accrual or redemption activity occurs. There is no default value, dependency, or limitation associated with this attribute. -
AdjustedListPrice: number
Title:
Adjusted List Price
The attribute is a currency that displays the redemption price that is used during redemption. There is no default value, dependency, nor limitation associated with this attribute. -
AmountValue: number
Title:
Amount
The total amount spent on the accrual or redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
ApproveDt: string
(date-time)
Title:
Approve Date
The transaction approval date. If the transaction involves an approval process, then the identifier indicates the date when the transaction is approved by the reviewer. There is no default value, dependency, or limitation associated with this attribute. -
BackupInvOrgId: integer
The organization from where inventory is being picked for a backup product. For example, when a transaction is created, sometimes the inventory or goods are picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is picked from a different organization. There is no default value, dependency, or limitation associated with this attribute.
-
BackupProductNumber: string
The backup product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute.
-
BookClassCode: string
Title:
Booking Class
Maximum Length:30
The booking class code. This attribute specifies the class of the airline ticket. The accepted values are ORA_TRAVL_BOOK_BUSI or ORA_TRAVL_BOOK_ECO. There is no default value, dependency, or limitation associated with this attribute. -
BookingClass: string
Title:
Booking Class Meaning
Read Only:true
Maximum Length:80
The booking class name. The identifier specifies the class of the airline ticket. The list of accepted values are: Economy, Business Class or First Class. There is no default value or limitation associated with this attribute. -
BookingDt: string
(date-time)
Title:
Booking Date
The transaction booking date. If the transaction is an airline transaction, then this attribute indicates the date when the booking is made for travel. There is no default value, dependency, or limitation associated with this attribute. -
CancelledTransactionId: integer
(int64)
Title:
Canceled Transaction
The canceled transaction identifier. This attribute is the primary key of the transaction that is canceled. There is no default value, dependency, or limitation associated with this attribute. -
CancelledTransactionNumber: string
Title:
Canceled Transaction Number
Maximum Length:30
The cancelled transaction number associated with the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
CancReasonCode: string
Title:
Cancellation Reason Code
Maximum Length:30
The cancellation reason code. This attribute value represents the reason why the transaction is canceled. There is no default value, dependency, or limitation associated with this attribute. -
ChildTransactionId: integer
(int64)
Title:
Child Transaction ID
The child transaction identifier. This attribute is the primary key of the transaction, that is, the child of the current transaction. There is no default value, dependency, or limitation associated with this attribute. -
ChildTransactionNumber: string
Title:
Child Transaction Number
Maximum Length:30
The child transaction number associated with the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
Comments: string
Title:
Comments
Maximum Length:250
The transaction comments. This attribute stores the comments entered by the user, if any, for future reference. There is no default value, dependency, or limitation associated with this attribute. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The currency code used by the corporation. There is no default value, dependency, or limitation associated with this attribute. -
CorporateReferenceNumber: string
Title:
Company Reference Number
Maximum Length:30
The reference to a third-party corporate member from the program to get the points allocated between the individual and the corporation or company, if an individual member completes a transaction on behalf of the corporation or company. There is no default value, dependency, or limitation associated with this attribute. -
CorpRefMemberId: integer
(int64)
Title:
Loyalty Member ID
The corporate reference member identifier. There is no default value, dependency, nor limitation associated with this attribute. -
CorpRefName: string
Title:
Company Reference
Maximum Length:100
The corporate reference member name. If the current member is part of the company or corporate account, then Oracle Loyalty Cloud populates this field. This is an optional attribute which is populated only when the transaction is done by an individual member on behalf of a company. There is no default value, dependency, or limitation associated with this attribute. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The details of who creates the transaction. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction. There is no default value, dependency, or limitation associated with this attribute. -
CreateInProgressStatusTxnFlag: boolean
Title:
Create a Transaction with In-Progress Status
Default Value:false
The flag which indicates that the transaction will get created and kept in In Progress status. This field and is an optional field for the REST API. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the transaction is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction. There is no default value, dependency, or limitation associated with this attribute. -
CurcyCode: string
Title:
Currency Code
Maximum Length:20
The transaction currency code. This attribute indicates the currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value or dependency associated with this attribute. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate method that is applied for the transaction. There is no default value, dependency, or limitation associated with this attribute. -
CurcyExchDt: string
(date-time)
Title:
Currency Exchange Date
The date when the currency exchange occurs during the creation of a transaction. There is no default value, dependency, or limitation associated with this attribute. -
Description: string
Title:
Product
The attribute indicates the description of the product that would be accrued or redeemed in the transaction. There is no default value, dependency, or limitation associated with this attribute. -
DestAirport: string
Title:
Destination Airport Meaning
Read Only:true
Maximum Length:80
The destination airport name. The attribute value is the name of the airport where the flight arrives on reaching its destination. There is no default value, dependency, nor limitation associated with this attribute. -
DestAirportCode: string
Title:
Destination Airport
Maximum Length:30
The destination airport code. This attribute value is a code representing the airport where the flight arrives when reaching its destination. The accepted values are ORA_AIRPORT_BOM, ORA_AIRPORT_BOS, or ORA_AIRPORT_SFO. There is no default value, dependency, or limitation associated with this attribute. -
DestCityCode: string
Title:
Destination City
Maximum Length:30
The destination city code. The attribute value represents the city where the flight arrives when it reaches its destination. There is no default value, dependency, or limitation associated with this attribute. -
DestZone: string
Title:
Destination Air Line Zone Meaning
Read Only:true
Maximum Length:80
The destination zone name. The attribute value is the name of the zone where the flight arrives on reaching its destination. The list of accepted values are: Asia, Europe, North America. There is no default value, dependency, nor limitation associated with this attribute. -
DestZoneCode: string
Title:
Destination Zone
Maximum Length:30
The zone where the flight arrives when it reaches its destination. The list of possible values are ORA_AIRLINE_ZONE_ASIA, ORA_AIRLINE_ZONE_EUROPE, or ORA_AIRLINE_ZONE_NAMER. There is no default value, dependency, or limitation associated with this attribute. -
DocumentNumber: string
Title:
Document Number
Maximum Length:30
The document number associated with the transaction. This attribute provides additional information in the transaction for the retail industry. There is no default value, dependency, or limitation associated with this attribute. -
EndDt: string
(date-time)
Title:
End Date
The transaction end date. This attribute is the date when the transaction is no longer in effect. This attribute value, if provided, must be set to a value after the StartDt attribute. There is no default value or dependency associated with this attribute. -
EventName: string
Title:
Event Name
Maximum Length:75
The event name associated with the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
ExpireInDays: number
Title:
Expires in Days
The date when the accrued points will expire, in days. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductLine: string
Title:
Product Line - External
Maximum Length:30
The product line associated with the product for the transaction that is from an external source. The accepted value is ORA_EXT_PROD_LINE_CG. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductLineMeaning: string
Title:
External Product Line Meaning
Read Only:true
Maximum Length:80
The external product line meaning. There is no default value, dependency, nor limitation associated with this attribute. -
ExternalProductName: string
Title:
Product Name - External
Maximum Length:240
The product name reference in the external system. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductTyeMeaning: string
Title:
External Product Type Meaning
Read Only:true
Maximum Length:80
The attribute specifies the types of products coming from an external system into the loyalty system. There is no default value, dependency, nor limitation associated with this attribute. -
ExternalProductType: string
Title:
Product Type - External
Maximum Length:30
The type of products coming into the Oracle Loyalty Cloud system from an external source. The accepted value is ORA_EXT_PROD_TYPE_ELEC. There is no default value, dependency, or limitation associated with this attribute. -
ExternalReservationNumber: string
Title:
External Reservation Number
Maximum Length:250
The external reservation number, specific to the airline industry, where a reservation is performed by an agent and has different reservation numbers. There is no default value, dependency, or limitation associated with this attribute. -
ExternalTransaction: string
Title:
External
Maximum Length:1
Default Value:N
The details of the transaction coming from a partner???s external application into loyalty when loyalty is integrated with a third-party application. There is no default value, dependency, or limitation associated with this attribute. -
FareBasis: string
Title:
Fare Basis
Maximum Length:30
The transaction fare basis. This attribute is a code that represents the fare basis on which the ticket fare is based. The accepted values are ORA_FARE_BASIS_BUSI or ORA_FARE_BASIS_ECO. There is no default value, dependency, or limitation associated with this attribute. -
FareBasisCode: string
Title:
Fare Basis Code
Maximum Length:30
The transaction fare basis code. This attribute is a code that represents the fare basis on which the ticket fare is based. The accepted values are ORA_FARE_BASIS_BUSI or ORA_FARE_BASIS_ECO. There is no default value, dependency, or limitation associated with this attribute. -
FareBasisMeaning: string
Title:
Fare Basis Meaning
Read Only:true
Maximum Length:80
The fare basis name. This attribute is the basis for the ticket fare. The list of accepted values are: Business, Economy. There is no default value, dependency, nor limitation associated with this attribute. -
FareType: string
Title:
Fare Type Meaning
Read Only:true
Maximum Length:80
The fare type name. The attribute value determines the ticket fare. The list of accepted values are: Business Class, First Class. There is no default value, dependency, nor limitation associated with this attribute. -
FareTypeCode: string
Title:
Fare Type
Maximum Length:30
The fare type code. This attribute is a code value that determines the class of the flight travel. The accepted values are ORA_FARE_BUSN_CLASS or ORA_FARE_FIRST_CLASS. There is no default value, dependency, or limitation associated with this attribute. -
FlightNumber: string
Title:
Flight Number
Maximum Length:30
The transaction flight number. If the transaction pertains to airlines, then this attribute indicates the flight number where the travel takes place. This attribute is input by the user during transaction creation. There is no default value, dependency, or limitation associated with this attribute. -
FltTypeCode: string
Title:
Flight Type Code
Maximum Length:30
The attribute specifies the flight type, for example, Boeing or Airbus. There is no default value, dependency, or limitation associated with this attribute. -
GdsRecLocator: string
Title:
GDS Record Locator
Maximum Length:30
The global distribution system (GDS) record locator. There is no default value, dependency, or limitation associated with this attribute. -
IncentivChoice: string
Title:
Incentive Choice
Maximum Length:30
The incentives or rewards that a member receives for enrolling into a promotion. There is no default value, dependency, or limitation associated with this attribute. -
IntegrationId: string
Title:
Integration ID
Maximum Length:30
The integration identifier of the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
InternalDest: string
Title:
Internal Destination
Maximum Length:15
The details of the destination that is used internally by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
InternalFlightDt: string
(date-time)
Title:
Internal Flight Date
The local date for the flight for the country. For example, 24/01/2018 is equal to GMT +5.30 in India. There is no default value, dependency, or limitation associated with this attribute. -
InternalOrigin: string
Title:
Internal Origin
Maximum Length:15
The flight origin details that are local to the region. There is no default value, dependency, or limitation associated with this attribute. -
InvOrgId: integer
(int64)
Title:
Inventory Organization ID
The organization from where inventory is being picked. For example, when a transaction is created, sometimes the inventory or goods are picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is being picked from a different organization. There is no default value, dependency, or limitation associated with this attribute. -
ItemNumber: string
Title:
Item Number
Maximum Length:30
The transaction item number that is used during the creation of a transaction. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the transaction is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are any changes to the transaction. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the transaction. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the transaction take place. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the transaction take place. There is no default value, dependency, or limitation associated with this attribute. -
LineItemNumber: integer
(int64)
Title:
Line Item Number
The line item number for a multiple line item order transaction. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoanBalance: number
Title:
Loan Balance
The remaining balance of the loan that you can use when creating a transaction. There is no default value, dependency, or limitation associated with this attribute. -
LoanRepaymentDt: string
(date-time)
Title:
Loan Repayment Date
The date which specifies when the loan is repaid. There is no default value, dependency, or limitation associated with this attribute. -
LocationName: string
Title:
Location Name
Maximum Length:30
The attribute is text that used in the retail industry for giving promotions. For example, for the same retailer, the promotion is applied only if the store is located in India. If the store is located outside India, then no promotions are applied. There is no default value, dependency, or limitation associated with this attribute. -
LoyAttrdefnBId: integer
(int64)
Title:
Attribute Definition ID
Read Only:true
The primary key of the loyalty attributes which are updated when a transaction is processed. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, nor limitation associated with this attribute. -
LoyTransactionId: integer
(int64)
Title:
Transaction ID
The primary key to identify a transaction. Oracle Loyalty Cloud generates this attribute value during the creation of a transaction record. There is no default value, dependency, or limitation associated with this attribute. -
MarketingFlightNumber: string
Title:
Marketing Flight Number
Maximum Length:30
The marketing flight number, which is specific to the airline industry and which indicates the flight number used in the airline's marketing campaign. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
Read Only:true
Maximum Length:30
The member for whom the transaction is created. There is no default value, dependency, or limitation associated with this attribute. -
OperFltNum: string
Title:
Operating Flight Number
Maximum Length:30
The operating flight number used in the airline transactions. There is no default value, dependency, nor limitation associated with this attribute. -
OptyCost: number
Title:
Opportunity Cost
The transaction opportunity cost associated with the transaction. There is no default value, dependency, or limitation associated with this attribute. -
OrderNumber: string
Title:
Order Number
Maximum Length:30
The number associated with an order. This attribute is used by Oracle Loyalty Cloud when consolidating transactions. There is no default value, dependency, or limitation associated with this attribute. -
OrderQuantity: number
Title:
Order Quantity
The transaction order quantity. This attribute indicates the number of points for which an order was placed. There is no default value, dependency, nor limitation associated with this attribute. -
OrganizationCode: string
Title:
Organization
Maximum Length:18
The organization code associated with the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
OrigAirport: string
Title:
Origination Airport Meaning
Read Only:true
Maximum Length:80
The attribute value is the name of the airport where the flight arrives on reaching its destination. There is no default value, dependency, nor limitation associated with this attribute. -
OrigAirportCode: string
Title:
Origin Airport
Maximum Length:30
The origin airport code. This attribute value represents the airport from where the flight departs. There is no default value, dependency, or limitation associated with this attribute. -
OrigAmount: number
Title:
Original Amount
The attribute specifies the total amount without any discount, and so on, being applied in the transaction. There is no default value, dependency, nor limitation associated with this attribute. -
OriginCityCode: string
Title:
Origin City Code
Maximum Length:30
The origin city code. This attribute value represents the city from where the flight departs. There is no default value, dependency, or limitation associated with this attribute. -
OrigOrderId: integer
(int64)
Title:
Original Order ID
The attribute indicates the original order identifier that led to the creation of these transactions. There is no default value, dependency, or limitation associated with this attribute. -
OrigOrdItmId: integer
(int64)
Title:
Original Order Line Item
The details of the order item that is originally placed, which is especially used for exchanges, and so on, in retail transactions. There is no default value, dependency, or limitation associated with this attribute. -
OrigPoints: number
Title:
Original Point
The original value of the transaction in points without any subsequent bonus added by each promotion. There is no default value, dependency, or limitation associated with this attribute. -
OrigZone: string
Title:
Origination Air Line Zone Meaning
Read Only:true
Maximum Length:80
The attribute is a name for the zone from where the flight departs. There is no default value, dependency, nor limitation associated with this attribute. -
OrigZoneCode: string
Title:
Origin Zone
Maximum Length:30
The code representing the zone from where the flight departs. Possible values are ORA_AIRLINE_ZONE_ASIA, ORA_AIRLINE_ZONE_EUROPE, or ORA_AIRLINE_ZONE_NAMER. There is no default value, dependency, or limitation associated with this attribute. -
OvrDupCheck: string
Title:
Duplicate Check Overridden
Maximum Length:1
Default Value:N
The flag that indicates whether duplicate line items are allowed in a transaction or not. There is no default value, dependency, or limitation associated with this attribute. -
OwnerId: integer
(int64)
Title:
Owner ID
The user that created the transaction and that owns the transaction. There is no default value, dependency, or limitation associated with this attribute. -
PackageCode: string
Title:
Package Code
Maximum Length:30
The transaction package code. This attribute identifies the package from which line items are picked. There is no default value, dependency, or limitation associated with this attribute. -
ParentTransactionId: integer
(int64)
Title:
Partner Transaction ID
The transaction identifier for the parent transaction that creates the current transaction. There is no default value, dependency, or limitation associated with this attribute. -
ParentTransactionNumber: string
Title:
Parent Transaction Number
Maximum Length:30
The parent transaction number associated with the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
PartitionName: string
Title:
Partition Name
Maximum Length:30
The transaction partition name. There is no default value, dependency, or limitation associated with this attribute. -
PartnerCompanyNumber: string
Title:
Partner Number
Read Only:true
Maximum Length:30
The partner company number associated with the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
PartnerNumber: string
Title:
Partner Number
The partner number attribute is a unique identifier from HZ_PARTIES that gives partner details for whom the transaction is being created. There is no default value, dependency, or limitation associated with this attribute. -
PaymentTypeMeaning: string
Title:
Payment Type Meaning
Read Only:true
Maximum Length:80
The payment type name which specifies how the payment is made for this transaction. There is no default value, dependency, nor limitation associated with this attribute. -
PeriodDurCode: string
Title:
Period Duration
Maximum Length:30
The period duration code that specifies the duration in days, or months, and so on. There is no default value, dependency, or limitation associated with this attribute. -
PeriodTypeCode: string
Title:
Period Type
Maximum Length:30
The period type code. Period type options are Months, Years, Lifetime, and so on. There is no default value, dependency, or limitation associated with this attribute. -
PnrName: string
Title:
PNR Name
Maximum Length:50
The transaction passenger name record (PNR) name. There is no default value, dependency, or limitation associated with this attribute. -
PnrNumber: string
Title:
PNR Number
Maximum Length:50
The transaction passenger name record (PNR) number. There is no default value, dependency, or limitation associated with this attribute. -
Points: number
Title:
Base Points
The attribute indicates the number of points that would be transferred for a TransferPoints redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeName: string
Title:
Point Type Name
The point type name. This attribute is dependent on the Program Name Identifier. There is no default value or limitation associated with this attribute. -
PostDt: string
(date-time)
Title:
Post Date
The date when the transaction is posted. There is no default value, dependency, or limitation associated with this attribute. -
PrConId: integer
(int64)
Title:
Primary Contact ID
Read Only:true
The attribute indicates the Primary Contact Id of the member for whom the transaction was created. There is no default value, dependency, or limitation associated with this attribute. -
PriceOverriden: string
Title:
Price Overridden
Maximum Length:1
Default Value:N
The flag that indicates whether the price must be overridden or not. There is no default value, dependency, or limitation associated with this attribute. -
ProcessDt: string
(date-time)
Title:
Processed Date
The transaction process date. This attribute specifies the day when the created transaction is processed. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingComment: string
Title:
Processing Information
Maximum Length:1000
The transaction processing comment that provides the details of an error, if any occurred, during transaction processing. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingLog: string
Title:
Processing Log
Maximum Length:1000
The transaction processing log that provides the details of all the promotions that are applied, all the points that are assigned, and all the vouchers that are assigned, if any. There is no default value, dependency, or limitation associated with this attribute. -
ProdId: integer
(int64)
Title:
Product ID
The product identifier of the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
ProductNumber: string
Title:
Product Number
The product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute. -
ProgramName: string
Title:
Program Name
The transaction program name. This attribute indicates the program for which the transaction is created. There is no default value, dependency, or limitation associated with this attribute. -
ProgramNumber: string
Title:
Program Number
Maximum Length:30
The program number associated with the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
PtnrProcDt: string
(date-time)
Title:
Partner Processing Date
The date on which the transaction is processed at the partner end. There is no default value, dependency, or limitation associated with this attribute. -
PtnrStatusCode: string
Title:
Partner Status Code
Maximum Length:30
The status code used by the partner on processing the transaction. There is no default value, dependency, or limitation associated with this attribute. -
PymtTypeCode: string
Title:
Payment Type
Maximum Length:30
The payment type code specifies how the payment is made for the transaction. There is no default value, dependency, or limitation associated with this attribute. -
QualifyingPointUsed: string
Title:
Qualifying
Maximum Length:1
Default Value:N
The qualifying point used. These qualifying points count towards a member???s tier status. There is no default value, dependency, or limitation associated with this attribute. -
QueuedProcessingFlag: boolean
Title:
Queued Processing
Maximum Length:1
Default Value:false
The flag, which if set to true in the input payload, then the transaction status is set to queue without processing it. There is no default value or limitation associated with this attribute. -
ReasonCode: string
Title:
Reason Code
Maximum Length:30
The reason for the cancellation or refund, if the transaction is cancelled. For example, a fee that is inadvertently applied. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionQuantity: number
Title:
Redemption Quantity
The quantity that would be redeemed in a redemption transaction. There is no default value, dependency, nor limitation associated with this attribute. -
RedemptionQuantityUOMCode: string
Title:
Unit of Measure for the Redemption Quantity
Maximum Length:30
The redemption products quantity unit of measure (UOM) code. For example, possible UOM codes are kilograms or litres. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByMemNumber: string
Title:
Referred-by Member Number
Read Only:true
Maximum Length:30
The member number referred by the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
RefundPct: number
Title:
Refund Percentage
The percentage of the refund that is granted in the transaction. There is no default value, dependency, or limitation associated with this attribute. -
RfndOvrdCmnts: string
Title:
Refund Override Comments
Maximum Length:250
The refund override comments in the event a refund is made. There is no default value, dependency, or limitation associated with this attribute. -
RfndOvrdRsnCode: string
Title:
Refund Override Reason
Maximum Length:30
The refund override reason code in the event a refund is made. There is no default value, dependency, or limitation associated with this attribute. -
SmActionType: string
Title:
Social Action Type Meaning
Read Only:true
Maximum Length:80
The social media action name. The list of accepted values are: Check-in, Rate, Share. There is no default value, dependency, nor limitation associated with this attribute. -
SmActionTypeCode: string
Title:
Social Action Type
Maximum Length:30
The code that provides the social media action type. The accepted values are ORA_SOCIAL_ACTION_CHECK_IN, ORA_SOCIAL_ACTION_RATE, or ORA_SOCIAL_ACTION_SHARE. There is no default value, dependency, or limitation associated with this attribute. -
Source: string
Title:
Transaction Source Meaning
Read Only:true
Maximum Length:80
The attribute the name corresponding to the source code. The list of accepted values are: Web, Mobile, Billing. There is no default value, dependency, nor limitation associated with this attribute. -
SourceCode: string
Title:
Source
Maximum Length:30
The code that represents the source of the transaction. The possible values are ORA_TXN_SOURCE_WEB, ORA_TXN_SOURCE_MOBILE, or ORA_TXN_SOURCE_BILL. There is no default value, dependency, or limitation associated with this attribute. -
StartDt: string
(date-time)
Title:
Start Date
The transaction start date. Either Oracle Loyalty Cloud generates this attribute value when a new transaction is created and populates the attribute with the current date, or it is entered by the user when creating the transaction using the resource. There is no default value, dependency, or limitation associated with this attribute. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:ORA_TXN_STAT_IN_PROG
The current state of the transaction. The accepted values are ORA_TXN_STAT_IN_PROG, ORA_TXN_STAT_REJ, or ORA_TXN_STAT_PROCESSED. There is no default value, dependency, or limitation associated with this attribute. -
StatusMeaning: string
Title:
Status Meaning
Read Only:true
Maximum Length:80
The transaction status meaning of the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
SubmitDt: string
(date-time)
Title:
Submit Date
The transaction submission date. Oracle Loyalty Cloud assigns this attribute value when the transaction is submitted for approval by changing the Transaction Status attribute value to Submitted. There is no default value, dependency, or limitation associated with this attribute. -
SubStatus: string
Title:
Sub Status Meaning
Read Only:true
Maximum Length:80
The attribute shows the name of the transaction substatus code. The list of possible values are: Success, No Promotions Qualified, Insufficient Member Balance, Insufficient Point Blocks. There is no default value, dependency, nor limitation associated with this attribute. -
SubStatusCode: string
Title:
Processing Sub Status
Maximum Length:30
The code that specifies the status of the transaction processing, for example, whether there is an error or the transaction is successful, and so on. The accepted values are ORA_TXN_SUB_STAT_ERROR, ORA_TXN_SUB_STAT_SUCCESS, or ORA_TXN_SUB_STAT_NO_PROMO_QF. There is no default value, dependency, or limitation associated with this attribute. -
SubTypeCode: string
Title:
Transaction Sub Type
Maximum Length:30
The transaction subtype name. This attribute is dependent on the TypeCodeName attribute. The accepted values are, A. if Accrual??? Product, Manual Credit, or B. if Redemption ??? Product, or Manual Debit. There is no default value, dependency, or limitation associated with this attribute. -
SubTypeMeaning: string
Title:
Subtype
Read Only:true
Maximum Length:80
The transaction sub type meaning of the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
TaxAmount: number
Title:
Tax Amount
The attribute indicates the tax that should be paid for the transaction after it is completed. There is no default value, dependency, nor limitation associated with this attribute. -
TicketNumber: string
Title:
Ticket Number
Maximum Length:30
The unique number that is used to identify the ticket booking for an airline transaction. There is no default value, dependency, or limitation associated with this attribute. -
ToMemberNumber: string
Title:
To Member
Maximum Length:30
The unique identification number of the member to whom points are transferred. There is no default value, dependency, or limitation associated with this attribute. -
TotalDays: integer
(int64)
Title:
Days
The total days that are required for travel between the source and destination locations. There is no default value, dependency, or limitation associated with this attribute. -
TotalLines: number
Title:
Total Lines
The total line items for the transaction. A transaction can include many order line items. There is no default value, dependency, or limitation associated with this attribute. -
TransactionChannel: string
Title:
Transaction Channel Meaning
Read Only:true
Maximum Length:80
The attribute is a code that provides the details on how the transaction is created. The list of accepted values are: ORA_TXN_CHANNEL_MOBILE, ORA_TXN_CHANNEL_WEB, ORA_TXN_CHANNEL_TELE. There is no default value, dependency, nor limitation associated with this attribute. -
TransactionChannelCode: string
Title:
Channel
Maximum Length:30
The code that indicates how the transaction is created. The accepted values are ORA_TXN_CHANNEL_MOBILE, ORA_TXN_CHANNEL_WEB, or ORA_TXN_CHANNEL_TELE. There is no default value, dependency, or limitation associated with this attribute. -
TransactionDate: string
(date-time)
Title:
Transaction Date
The date when the transaction is completed. There is no default value, dependency, or limitation associated with this attribute. -
TransactionNumber: string
Title:
Transaction Number
Maximum Length:30
The transaction number. This is an alternate key that is mandatory during an update. This attribute is automatically generated by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
TransactionSourceCode: string
Title:
Transaction Source Code
Maximum Length:30
The transaction source code attribute indicates the transaction activity type like Airlines, Hotels, Car Rental, and so on. There is no default value, dependency, or limitation associated with this attribute. -
TransferMemNumber: string
Title:
Transfer to Member
Maximum Length:30
The member number to which the points were transferred. There is no default value, dependency, or limitation associated with this attribute. -
TransferPoints: number
Title:
Transfer Points
The attribute indicates the number of points that would be transferred in a TransferPoints redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
TrvClass: string
Title:
Travel Class Meaning
Read Only:true
Maximum Length:80
The travel class name. This identifier indicates the class of the travel. The list of accepted values are: Business, Economy. There is no default value or limitation associated with this attribute. -
TrvClassCode: string
Title:
Travel Class
Maximum Length:30
The code that indicates the class in which the passenger is traveling. The accepted values are ORA_TRAVL_CLASS_BUSI or ORA_TRAVL_CLASS_ECO. There is no default value, dependency, or limitation associated with this attribute. -
TrvlDistance: number
Title:
Distance
The transaction travel distance. This attribute stores the total miles travelled. There is no default value, dependency, or limitation associated with this attribute. -
TypeCode: string
Title:
Transaction Type
Maximum Length:30
The transaction type code name. The accepted values are ORA_TIER, ORA_TXN_ACC, or ORA_TXN_RED. There is no default value, dependency, or limitation associated with this attribute. -
TypeMeaning: string
Title:
Type Meaning
Read Only:true
Maximum Length:80
The transaction type meaning of the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
UnaccMinor: string
Title:
Unaccounted Minor
Maximum Length:1
Default Value:N
The unaccounted transaction for a minor, that is below the age of majority. There is no default value, dependency, or limitation associated with this attribute. -
ValStatusCode: string
Title:
Value Status Code
Maximum Length:30
The status of the validation performed on the record. There is no default value, dependency, or limitation associated with this attribute. -
VoucherNumber: string
Title:
Voucher Number
The alternative way to identify a member voucher. The UI shows the voucher number but the VoucherNumber attribute is used in the URI to update a voucher record using the resource. The VoucherNumber attribute can also be used as a parameter for the validateVoucherFinder finder. There is no default value, dependency, or limitation associated with this attribute. -
VoucherQuantity: number
Title:
Voucher Quantity
The attribute provides details of how many vouchers are assigned because of the given transaction after processing. There is no default value, dependency, nor limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyMembers-pointbalances-item-response
Type:
Show Source
object
-
Balance: number
Read Only:
true
The point balance. The numeric value of the point balance of the point type. There is no default value, dependency, or limitation associated with this attribute. -
Futurepoints: number
Read Only:
true
The loyalty member future points. There is no default value, dependency, or limitation associated with this attribute. -
Lifetimepoints: number
Read Only:
true
The member lifetime point balance. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyAttrdefnBId: integer
(int64)
Read Only:
true
The Primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, nor limitation associated with this attribute. -
LoyMemberId: integer
(int64)
Read Only:
true
The member identifier of the point balance. The member's primary key identifier for whom the point balance is displayed. There is no default value, dependency, or limitation associated with this attribute. -
PointType: string
Read Only:
true
Maximum Length:30
The point type of the point balance. There is no default value, dependency, or limitation associated with this attribute. -
Qualifyingbalance: number
Read Only:
true
The member qualifying point balance. The qualifying point type's point balance is used for tier assesment. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyMembers-pointItems-item-response
Type:
Show Source
object
-
AccrualedValue: number
Title:
Number of Points
The points accrued value for the points that are accrued by the member. There is no default value, dependency, or limitation associated with this attribute. -
AccrualEffDt: string
(date-time)
Title:
Accrual Start Date
Displays the date from which the points would be effective, that is, the date when the points are available for redemption. Point items having a future effective date will fall under the 'Future Points' category and would move under 'Available Points' once the effectivity date is reached. There is no default value, dependency, or limitation associated with this attribute. -
AccrualItemNumber: string
Title:
Item Number
Maximum Length:30
The accrual item number reference which shows accrual information to reach this point balance. There is no default value or limitation associated with this attribute. -
ActionNote: string
Title:
Action Note
Read Only:true
Maximum Length:1000
The attribute indicates additional information pertaining to an accrual action that resulted in the creation of the accrual item. There is no default value or limitation associated with this attribute. -
Active: string
Title:
Active
Read Only:true
Maximum Length:1
The accrual item active flag. This attribute is a boolean flag which indicates whether the accrual item is active or not. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Created Date
Read Only:true
The date when the accrual Item is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction. There is no default value, dependency, or limitation associated with this attribute. -
DisplayName: string
Title:
Point Type
Read Only:true
Maximum Length:30
The name of the point type for which the accrual Item is created during transaction processing. There is no default value, dependency, or limitation associated with this attribute. -
ExpirationDt: string
(date-time)
Title:
Expiration Date
The date when the points that have accrued expire. There is no default value, dependency, or limitation associated with this attribute. -
ExpiredValue: number
The point items which have expired. There is no default value, dependency, or limitation associated with this attribute.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyAcrlItmId: integer
(int64)
Title:
Loyalty Accrual Item ID
The accrual item identifier to identify which accrual item has a specific point balance value. There is no default value or limitation associated with this attribute. -
MemberNumber: string
The member for whom the accrual item is created. There is no default value, dependency, or limitation associated with this attribute.
-
Name: string
Title:
Point Subtype
Read Only:true
Maximum Length:50
The name of the point type that is accrued by the member. There is no default value, dependency, or limitation associated with this attribute. -
NumberOfPoints: number
Title:
Number Points
Read Only:true
The number of points that have been accrued as a result of accrual type transactions being processed. There is no default value, dependency, or limitation associated with this attribute. -
OrderNumber: string
Maximum Length:
30
The number associated with an order. This attribute is used by Oracle Loyalty Cloud when consolidating transactions. There is no default value, dependency, or limitation associated with this attribute. -
PointBlkId: integer
(int64)
Title:
Point Block ID
The attribute indicates the primary key of the point block from which the accrued points are allocated to the member. There is no default value, dependency, or limitation associated with this attribute. -
ProcessDt: string
(date-time)
Title:
Processed Date
The transaction process date. This attribute specifies the day on which the created transaction is processed that resulted in the creation of accrual items. There is no default value, dependency, or limitation associated with this attribute. -
ProdId: integer
(int64)
Title:
Product ID
Read Only:true
The foreign key of loyalty products. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute. -
ProductNumber: string
Read Only:
true
The product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute. -
ProgramName: string
Read Only:
true
The name of the program in which the transaction is created. There is no default value, dependency, or limitation associated with this attribute. -
PromoObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Read Only:true
The promotion object number associated with the point item. Oracle Loyalty Cloud populates this value when the point item is created in the UI. There is no default value, dependency, or limitation associated with this attribute. -
PromotionName: string
Title:
Promotion
Read Only:true
Maximum Length:50
The name of the promotion that has been applied and for which the accrual items are created during transaction processing. There is no default value, dependency, or limitation associated with this attribute. -
PromotionNumber: string
Title:
Promotion Number
Read Only:true
Maximum Length:30
The promotion number that has been applied to the member and associated with the point item. There is no default value, dependency, or limitation associated with this attribute. -
QualifyingFlag: boolean
Title:
Qualifying
Maximum Length:1
Default Value:false
The boolean attribute indicates whether the accrued points are qualifying points or not. Qualifying points count toward a member???s tier status. The default value is N. There is no dependency or limitation associated with this attribute. -
Status: string
Title:
Status Meaning
Read Only:true
Maximum Length:80
The point item status, which shows whether a particular point item is active or not. There is no default value or limitation associated with this attribute. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The code that represents the status of the accrual item. The accepted values are ORA_LOY_AVAILABLE, ORA_LOY_CANCELLED or ORA_LOY_EXPIRED. There is no default value, dependency, or limitation associated with this attribute. -
TransactionAmount: number
Title:
Amount
Read Only:true
The currency value amount of the transaction from transactions. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute. -
TransactionNumber: string
Title:
Transaction Number
Maximum Length:30
The transaction number which uniquely identifies the loyalty transaction. This attribute is automatically generated by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
TypeCode: string
Title:
Type Code
Maximum Length:30
The point item type code associated with an order. There is no default value, dependency, or limitation associated with this attribute. -
UsedValue: number
Title:
Used Value
The total points from the accrued points that have been used. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyMembers-PromotionAttributeDetail-item-response
Type:
Show Source
object
-
ActionNote: string
Title:
Action Note
Read Only:true
Maximum Length:1000
The message written by an engine action when Oracle Loyalty Cloud updates the Member Promotion attribute. There is no default value, dependency, or limitation associated with this attribute. -
DisplayName: string
Title:
Attribute Name
Read Only:true
Maximum Length:255
The member promotion attribute name. This attribute is a child resource for the member, which contains the value of the promotion specific attributes for this particular member, if any. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberId: integer
(int64)
Read Only:
true
The primary key identifier for the loyalty member by whom the transaction has updated the Promotion attribute for the member. There is no default value, dependency, or limitation associated with this attribute. -
Name: string
Title:
Promotion
Read Only:true
Maximum Length:255
The promotion name that shows the information regarding the loyalty promotion for which the promotion level attributes have been applied by the Oracle Loyalty Cloud engine. There is no default value, dependency, or limitation associated with this attribute. -
ProcessedDt: string
(date-time)
Title:
Processed Date
Read Only:true
The date when the promotion attribute is processed. When the Oracle Loyalty Cloud engine initiates bucket processing, it sets the date when it updates the promotion attributes. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingComment: string
Title:
Comments
Read Only:true
Maximum Length:255
The transaction processing comments when the promotion attribute is updated. There is no default value, dependency, or limitation associated with this attribute. -
PromotionId: integer
(int64)
Read Only:
true
The primary key identifier of the loyalty promotion for which the promotion attribute is defined. There is no default value, dependency, or limitation associated with this attribute. -
Status: string
Read Only:
true
Maximum Length:80
The status of the promotion attribute, which indicates whether this attribute is active or not. There is no default value, dependency, nor limitation associated with this attribute. -
StatusCode: string
Title:
Status
Read Only:true
Maximum Length:255
The promotion attribute status that shows the status of processing of the bucket attributes by the Oracle Loyalty Cloud engine. The corresponding finder lookup type is ORA_LOY_PROMO_BUCKET_STATUS. There is no default value, dependency, or limitation associated with this attribute. -
Value: string
Title:
Attribute Value
Read Only:true
Maximum Length:250
The promotion attribute value after the Oracle Loyalty Cloud engine updates the promotion level attribute value through bucket processing or by applying loyalty promotions which updates the value of the attribute. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyMembers-promotions-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The details of who updated the member enrollment into an enrollable promotion. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Created Date
Read Only:true
The date when the member enrollment into an enrollable promotion is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion. There is no default value, dependency, or limitation associated with this attribute. -
EligFlg: string
Title:
Eligibility
Maximum Length:1
Default Value:N
Indicates if member is eligible or enrolled. -
EnrollmentEnd: string
(date-time)
Title:
Enrollment End Date
The promotion enrollment end date, which is the date until the current member is enrolled to a particular enrollable promotion. The promotion enrollment end date should be later than promotion enrollment start date. There is no default value associated with this attribute. -
EnrollmentStart: string
(date-time)
Title:
Enrollment Start Date
The date when the promotion enrollment begins. A loyalty member can be enrolled into a particular promotion beginning on this date. There is no default value, dependency, or limitation associated with this attribute. -
IncentiveChoice: string
Title:
Incentive Choice
The incentive choice option for an enrollable promotion. One of the many defined preferred choices can be setup for each member. If no choice is selected for a member, the one defined as a default incentive choice is used. There is no dependency or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the member enrollment into an enrollable promotion was last updated. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the promotion. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Changed By
Read Only:true
Maximum Length:64
The user that updates the member enrollment into an enrollable promotion record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the member enrollment into an enrollable Promotion in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the member enrollment into an enrollable promotion take place. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyPromomemId: integer
(int64)
Title:
Loyalty Promotion Member ID
The loyalty promotion member identifier, which is the primary identifier to uniquely identify a loyalty member enrolled into a loyalty promotion for a given period. There is no default value, dependency, or limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member ID
The primary key of the member identifier who is currently enrolled in an enrollable promotion. There is no default value or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
Maximum Length:30
The loyalty member number, which is an alternative key to identify a member. This number is shown along with the promotion name when identifying a member enrollment into an enrollable promotion for a given start and end date. There is no default value, dependency, or limitation associated with this attribute. -
OfferNum: string
Title:
Offer Number
Maximum Length:30
. -
PromoMemNumber: string
Title:
Promotion Member Number
The public unique identifier of a member promotion enrolled object which is unique to a given enrollment for a given time period. There is no default value or limitation associated with this attribute. -
PromotionName: string
Title:
Promotion Name
The loyalty promotion name which has the enrollable promotion flag enabled and for which the enrollment start and end date is specified for the current loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
PromotionNumber: string
Title:
Promotion Number
Read Only:true
Maximum Length:30
The promotion number that has been applied to the member during the transaction processing. There is no default value, dependency, or limitation associated with this attribute. -
SubTypeCode: string
Title:
Promotion Sub Type
Read Only:true
Maximum Length:30
The loyalty promotion subtype shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute. -
SubTypeCodeMeaning: string
Title:
Promotion Sub Type Meaning
Read Only:true
Maximum Length:80
The sub type meaning of the promotion. This is dependent on the promotion type. There is no default value or limitation associated with this attribute. -
TypeCode: string
Title:
Promotion Type
Read Only:true
Maximum Length:30
The loyalty promotion type shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute. -
TypeCodeMeaning: string
Title:
Promotion Type Meaning
Read Only:true
Maximum Length:80
The type meaning of the promotion which is based on the promotion type code. There is no default value or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyMembers-vouchers-item-response
Type:
Show Source
object
-
ActionNote: string
Title:
Action Note
Maximum Length:1000
The attribute indicates additional information pertaining to a voucher action for which the voucher was created. There is no default value or limitation associated with this attribute. -
ActivityDate: string
The date used by Oracle Loyalty Cloud to fetch a valid voucher for a given activity date. The ActivityDate attribute is a parameter used in the availableVoucherFinder and the validateVoucherFinder finders. There is no default value, dependency, or limitation associated with this attribute.
-
Basis: string
Title:
Voucher Basis Meaning
Read Only:true
Maximum Length:80
The list of value meaning for the Basis code. There is no default value or limitation associated with this attribute. -
BasisCode: string
Title:
Voucher Basis
Maximum Length:30
This is a FND lookup value. To get the possible input values, the user needs to first invoke corresponding lovResourcepath URL: ../crmRestApi/resources/11.12.0.0/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_BASIS There is no default value, dependency, or limitation associated with this attribute. -
ConsumedTransactionNumber: string
Title:
Redeemed Transaction Number
Maximum Length:30
The transaction number that used this voucher. There is no default value, dependency, or limitation associated with this attribute. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The details of who created the voucher. Oracle Loyalty Cloud generates this attribute value during the creation of a new voucher. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the voucher was created. Oracle Loyalty Cloud generates this attribute value during the creation of a new voucher. There is no default value, dependency, or limitation associated with this attribute. -
CurcyExchDt: string
(date)
Title:
Currency Exchange Date
The currency exchange date associated with the voucher. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyAmount: number
Title:
Voucher Discount Value
The currency amount which signifies the value of the voucher based on currency. There is no default value, dependency, nor limitation associated with this attribute. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the voucher. There is no default value, dependency, or limitation associated with this attribute. -
Description: string
Title:
Type
Read Only:true
Maximum Length:240
The product description for the voucher. The user enters the description of product as the VoucherType, which is displayed as the product description on the Loyalty Voucher UI page. Oracle Loyalty Cloud assigns the ProdId attribute value with the identifier of the product when the user inputs the product description. There is no default value, dependency, or limitation associated with this attribute. -
DiscountValue: string
Read Only:
true
The voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, then the value of discount must be a positive integer. This value is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute. -
ExpirationDt: string
(date-time)
Title:
Expiration Date
The expiration date of the voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or the attribute value can be provided as an input when creating a voucher using the resource. There is no default value, dependency, or limitation associated with this attribute. -
InvOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the organization that provides the inventory when the user is redeeming the vouchers. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Change Date
Read Only:true
The date when the voucher was last updated. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the voucher. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Changed By
Read Only:true
Maximum Length:64
The user who last updated the voucher. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the voucher. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyMemVchrId: integer
(int64)
Title:
Voucher ID
The primary key identifier which signifies unique value for a generated voucher record. There is no default value, dependency, nor limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member ID
The primary key of the member to whom the voucher is assigned. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
The member number of the loyaltyMember attribute to whom the voucher is assigned. The MemberNumber attribute is used when assigning a voucher or creating a voucher using the resource. The MemberNumber attribute is also used as a parameter in the availableVoucherFinder finder. There is no default value or dependency associated with this attribute. -
Name: string
Title:
Promotion
Read Only:true
Maximum Length:50
The attribute indicates the name of the promotion for which the voucher was created. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationCode: string
Title:
Organization Code
Maximum Length:18
The organization code associated with the member voucher. There is no default value, dependency, or limitation associated with this attribute. -
OriginalVoucherNumber: string
Title:
Original Voucher Number
Maximum Length:30
The original voucher number associated with the voucher. There is no default value, dependency, or limitation associated with this attribute. -
PrConId: integer
(int64)
Title:
Primary Contact ID
Read Only:true
The attribute indicates the primary contact identifier of the member for whom the voucher was created. There is no default value, dependency, or limitation associated with this attribute. -
ProductNumber: string
Title:
Product Number
The identifier of the product for an existing voucher, that is used for specifying product information. There is no default value, dependency, or limitation associated with this attribute. -
PromotionNumber: string
Title:
Promotion Number
Maximum Length:30
The promotion number that was applied to the transaction during transaction processing and that created this voucher.There is no default value, dependency, or limitation associated with this attribute. -
Quantity: number
Title:
Quantity
Default Value:1
The voucher quantity which shows how many vouchers are assigned by the transaction processing. There is no default value or limitation associated with this attribute. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:ORA_VOUC_STATUS_AVLBL
The attribute indicates the status of the voucher. The accepted values can be obtained by invoking fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_STATUS. The StatusCode attribute can be changed from ORA_VOUC_STATUS_AVLBL to ORA_VOUC_STATUS_USED only through a PATCH request. There is no default value, dependency, or limitation associated with this attribute. -
StatusMeaning: string
Title:
Voucher Status Meaning
Read Only:true
Maximum Length:80
The voucher status meaning which shows the voucher status as follows: Available, Expired, Used, and so on. There is no default value, dependency, nor limitation associated with this attribute. -
TxnId: integer
(int64)
Title:
Transaction ID
Read Only:true
The transaction Identifier which led to the assignment of loyalty vouchers due to transaction processing. There is no default value or limitation associated with this attribute. -
TxnItemId: integer
(int64)
Title:
Transaction Item ID
The transaction item identifier which signifies the transaction identifier assigned while processing the transaction. There is no default value, dependency, nor limitation associated with this attribute. -
TxnNum: string
Title:
Transaction Number
Read Only:true
Maximum Length:30
The transaction number that shows the transaction processing that has assigned this voucher to member. There is no default value or limitation associated with this attribute. -
UsedDt: string
(date-time)
Title:
Used Date
The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute. -
validFlag: boolean
The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.
-
VchrBasis: string
Title:
Discount Type Meaning
Read Only:true
Maximum Length:80
The list of value meaning for the voucher basis code, which signifies whether the voucher is absolute or percentage based. There is no default value, dependency, nor limitation associated with this attribute. -
VchrBasisCode: string
Title:
Discount Type
Maximum Length:30
The attribute indicates the discount type that the voucher offers. Accepted values are ORA_VOUC_BASIS_ABSOLUTE or ORA_VOUC_BASIS_PERCENTAGE. It is provided as input from a user when creating the voucher. There is no default value, dependency, or limitation associated with this attribute. -
VoucherDiscountValue: number
Title:
Voucher Discount Value
The voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, then the value of discount must be a positive integer. This value is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute. -
VoucherEffectiveStartDt: string
(date)
Title:
Start Date
The date when the voucher is in effect. This date is assigned during an Assign Voucher action or when the voucher is created using the resource. There is no default value, dependency, or limitation associated with this attribute. -
VoucherNumber: string
Title:
Voucher Number
Maximum Length:30
The alternative way to identify a voucher. The UI shows the voucher number but the VoucherNumber attribute is used in the URI to update a voucher record using the resource. The VoucherNumber attribute can also be used as a parameter for the validateVoucherFinder finder. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AccountType
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_ACCOUNT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: AccountTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ContactLOV
-
Operation: /crmRestApi/resources/11.13.18.05/contactsThe list of contacts for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: PartyName; Target Attribute: PartyName
- Display Attribute: PartyName
- MemberAccrualType
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_ACCRU_TYPE
The list of accrual types for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: AccrualTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberAttributes
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The member attributes resource is used to retrieve the details of a member attribute associated with the loyalty member. - MemberNumber:
- MemberClass
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_CLASS%2CBindLookupCode%3D{MemberClassCode}
The list of classes for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: MemberClassCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberContact
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The member contact resource is used to retrieve the details of a contact that is associated with the loyalty member. - MemberNumber:
- MemberGroup
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_GRP%2CBindLookupCode%3D{MemberGrpCode}
The list of groups for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: MemberGrpCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberPhase
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_PHASE%2CBindLookupCode%3D{MemberPhaseCode}
The list of phases for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: MemberPhaseCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberReferrals
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The member referrals resource is used to retrieve the contacts that are referred by the loyalty member. - MemberNumber:
- MemberTier
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The member tier resource is used to retrieve the member tier details for the loyalty member. - MemberNumber:
- MemberTransactions
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The member transactions resource is used to retrieve the details of transactions performed by the loyalty member. - MemberNumber:
- MemberType
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_TYPE
The list of types for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: MemberTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PersonLOV
-
Operation: /crmRestApi/resources/11.13.18.05/contactsThe list member names.
The following properties are defined on the LOV link relation:- Source Attribute: ContactName; Target Attribute: PersonName
- Display Attribute: PersonName
- PromotionAttributeDetail
-
Operation: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/PromotionAttributeDetailParameters:
- MemberNumber:
$request.path.MemberNumber
The promotion attribute detail resource is used to retrieve the details of a member promotion attribute associated with the loyalty member. - MemberNumber:
- RatedCurrenciesVO
-
The list of currencies for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode
- ReferredByLOV
-
Operation: /crmRestApi/resources/11.13.18.05/loyMembersThe list of referrals for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: ReferredByNam; Target Attribute: MemberName
- Display Attribute: MemberName
- ReferredByMemberVA
-
Operation: /crmRestApi/resources/11.13.18.05/loyMembersThe list of referrals for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: ReferredByNumber; Target Attribute: MemberNumber
- Display Attribute: MemberNumber, LoyMemberId
- ReferredbyUILOV
-
Operation: /crmRestApi/resources/11.13.18.05/loyMembersThe following properties are defined on the LOV link relation:
- Source Attribute: ReferredByName; Target Attribute: MemberName
- Display Attribute: MemberName
- activities
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The activities resource is used to retrive the details of activities associted with the loyalty members. - MemberNumber:
- cards
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The cards resource is used to retrieve the details of membership cards for the given loyalty member. - MemberNumber:
- groupMembers
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The group members resource is used to retrieve the details of a group member attribute associated with the loyalty member. - MemberNumber:
- individualMembers
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The individual members resource is used to retrieve the details of an individual member attribute associated with the loyalty member. - MemberNumber:
- pointItems
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The point items resource is used to retrieve the point items detail for a loyalty member. - MemberNumber:
- pointbalances
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The point balances resource is used to retrieve the point balance detail for a loyalty member. - MemberNumber:
- promotions
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The promotions resource is used to retrieve the details of a promotion enrolled by the loyalty member. - MemberNumber:
- vouchers
-
Parameters:
- MemberNumber:
$request.path.MemberNumber
The vouchers resource is used to retrieve the vouchers that are assigned to the loyalty member. - MemberNumber:
Examples
This example shows the update request and response payload when updating member number 300100129329081, which you created in the A2Z Bank program. This example updates the email address to john.doh@yahoo.com and the mobile number to 6769866987.
Use PATCH with the following URI syntax to update the member:
https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300100129329081
Example of Request Body
{
"PassEmailAddress": "john.doh@yahoo.com",
"MobileNumber": "6769866987"
}
Example of Response Header
cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -1843
content-type -application/vnd.oracle.adf.resourceitem+json
date -Tue, 21 Aug 2018 19:46:36 GMT
etag -"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000047371007E00020000000778"
keep-alive -timeout=61, max=100
link - <https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081>;rel="self";kind="item";name="loyMembers"
location -
rest-framework-version -1
server -Oracle-HTTP-Server
vary -User-Agent
x-content-type-options -nosniff
x-oracle-dms-ecid -005SzT8c0lhEoIILIqL6if0001wh0002zO
Example of Response Body
{
"LoyMemberId" : 300100129329080,
"MemberClassCode" : null,
"MemberGrpCode" : null,
"MemberNumber" : "300100129329081",
"MemberPhaseCode" : null,
"MemberTypeCode" : "ORA_MEM_TYPE_INDIVIDUAL",
"MemberName" : "John Doh",
"PrConId" : 300100129329082,
"StatusCode" : "ORA_MEM_STATUS_ACTIVE",
"ValLifeScore" : null,
"StartDate" : "2018-08-21T16:41:23.890+00:00",
"SysEffectiveDate" : null,
"PersonName" : "John Doh",
"ContactDateOfBirth" : null,
"ReferredByName" : null,
"ReferredByNam" : null,
"PointTypeAVal" : 0,
"RelationshipId" : null,
"CorpCurrencyCode" : "USD",
"CurcyConvRateType" : "Corporate",
"CurrencyCode" : "USD",
"RelationshipType" : null,
"RelationshipRecId" : null,
"reltype" : null,
"ReferConId" : null,
"EmailAddress" : null,
"FormattedPhoneNumber" : "+1 (676) 986-6986",
"TierName" : "Bronze",
"Points" : "0",
"AccrualTypeCode" : null,
"AccntId" : null,
"ContactName" : "John Doh",
"AccrualToMemId" : null,
"AccrualToHouseholdFlag" : null,
"OrgGroupId" : null,
"AccrualStartDate" : null,
"ApprovalDate" : null,
"ApprByEmployeeId" : null,
"CreationSource" : null,
"ContactId" : null,
"CurrencyDate" : null,
"CorpMemberNumber" : null,
"ChildNumber" : null,
"DateOfBirth" : null,
"DescriptionText" : null,
"DisplaySequence" : null,
"ExpiryDate" : null,
"HomeAirport" : null,
"IncompleteFlights" : null,
"LftmPointTypeBVal" : null,
"LftmPointTypeCVal" : null,
"LftmPointTypeDVal" : null,
"LftmPointTypeEVal" : null,
"LftmPointTypeFVal" : null,
"LftmPointTypeGVal" : null,
"LftmPointTypeHVal" : null,
"LoungeStartDt" : null,
"LoungeBuyEndDt" : null,
"LoungeCode" : null,
"LoungeBuyCode" : null,
"LastAccrTransactionDt" : null,
"LastRdmTransactionDt" : null,
"LoungeEndDate" : null,
"LoungeBuyStartDt" : null,
"LoyLstStmtDt" : null,
"LstStmtId" : null,
"LstTierChangeDt" : null,
"LoungeNumber" : null,
"LastTransactionProcedDt" : null,
"LftmPointTypeAVal" : null,
"MaximumPointStatCode" : null,
"MembershipSchemeId" : null,
"MaximumPointLoan" : null,
"MaximumPointTypeId" : null,
"MemberClassMeaning" : null,
"MemberPhaseMeaning" : null,
"ParMemberId" : null,
"ParentMember" : "N",
"PINNumber" : null,
"PnrName" : null,
"PointTypeBVal" : 0,
"PointTypeCVal" : 0,
"PointTypeDVal" : 0,
"PointTypeEVal" : 0,
"PointTypeFVal" : 0,
"PointTypeGVal" : 0,
"PointTypeHVal" : 0,
"PassContactFirstName" : null,
"PassContactLastName" : null,
"PassContactName" : null,
"PassEmailAddress" : "john.doh@yahoo.com",
"PassMobileNumber" : null,
"PassWorkPhoneNumber" : null,
"PrAddrId" : null,
"PrDomTierId" : null,
"PrPostnId" : null,
"PreferCommMethCode" : null,
"ReceivePromotion" : "N",
"RecPtnrPromotion" : "N",
"RegChannelCode" : null,
"RootMemId" : null,
"ReferredByNumber" : null,
"StmtMthdCode" : null,
"StmtTypeCode" : null,
"SubmitDate" : null,
"SubmitToEmployeeId" : null,
"SuppressCall" : "N",
"SuppressEmail" : "N",
"SuppressFax" : "N",
"SuppressMail" : "N",
"SuppressSMS" : "N",
"ValScore" : null,
"GroupLookupType" : null,
"GroupLookupCode" : null,
"AccrualMeaning" : null,
"AccrualLookupType" : null,
"AccrualLookupCode" : null,
"PreviousTierName" : null,
"WorkPhoneNumber" : null,
"PhoneNumber" : "+1 (676) 986-6986",
"PersonLastName" : "Doh",
"PersonFirstName" : "John",
"PartyName" : "John Doh",
"MemberEmailAddress" : null,
"MobileNumber" : "6769866987",
"LoyProgramName" : "A2Z Bank",
"LoyHouseholdName" : null,
"LoyAccountName" : null,
"AddressLineOne" : null,
"AddressLineTwo" : null,
"AddressLineThree" : null,
"City" : null,
"Country" : null,
"County" : null,
"PostalCode" : null,
"Province" : null,
"State" : null,
"JobTitle" : null,
"URL" : null,
"AccrualToHousehold" : null,
"HouseholdMemberNumber" : null,
"ContactFirstName" : "John",
"ContactLastName" : "Doh",
"CreatedBy" : "LOYALTY_PROGRAM_ADMINISTRATOR",
"CreationDate" : "2018-08-21T16:41:23+00:00",
"LastUpdateDate" : "2018-08-21T19:46:37+00:00",
"LastUpdateLogin" : "73E1D726179B0058E05334C4F00A2219",
"LastUpdatedBy" : "LOYALTY_PROGRAM_ADMINISTRATOR",
"AccountTypeCode" : null,
"links" : [ {
"rel" : "self",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081",
"name" : "loyMembers",
"kind" : "item",
"properties" : {
"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000047371007E00020000000778"
}
}, {
"rel" : "canonical",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081",
"name" : "loyMembers",
"kind" : "item"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/PersonLOV",
"name" : "PersonLOV",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/MemberPhase",
"name" : "MemberPhase",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/ReferredByMemberVA",
"name" : "ReferredByMemberVA",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/MemberAccrualType",
"name" : "MemberAccrualType",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/MemberType",
"name" : "MemberType",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/ReferredByLOV",
"name" : "ReferredByLOV",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/ContactLOV",
"name" : "ContactLOV",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/MemberGroup",
"name" : "MemberGroup",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/MemberStatus",
"name" : "MemberStatus",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/RatedCurrenciesVO",
"name" : "RatedCurrenciesVO",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/MemberClass",
"name" : "MemberClass",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/lov/AccountType",
"name" : "AccountType",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/MemberAttributes",
"name" : "MemberAttributes",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/promotions",
"name" : "promotions",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/pointbalances",
"name" : "pointbalances",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/MemberContact",
"name" : "MemberContact",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/MemberReferrals",
"name" : "MemberReferrals",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/vouchers",
"name" : "vouchers",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/PromotionAttributeDetail",
"name" : "PromotionAttributeDetail",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/MemberTransactions",
"name" : "MemberTransactions",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/MemberTier",
"name" : "MemberTier",
"kind" : "collection"
}, {
"rel" : "child",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyMembers/300100129329081/child/cards",
"name" : "cards",
"kind" : "collection"
} ]
}