1. REST API for Oracle Loyalty Cloud
  2. Tasks
  3. (Deprecated) Loyalty Members

Get a loyalty member (Deprecated)

get

/crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}

Request

Path Parameters
  • The member number. This attribute is an alternative identifier for a member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : loyaltyMembers-item-response
Type: object
Show Source
  • Title: Account ID
    The account identifier for the member's partner object. 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 associated with this attribute.
  • The member account name for the member's partner object. If the MemberType attribute is Company, then Oracle Loyalty Cloud populates AccountName. This attribute depends on the value of the MemberType attribute. Oracle Loyalty Cloud populates the AccountName attribute based on the AccountId attribute. There is no default value or limitation associated with this attribute.
  • The member account type shows a list of finder lookup values. The associated lookup type is ZCA_ACCOUNT_TYPE. For example, the attribute can have a value of Corporate. This attribute depends on the MemberType attribute. There is no default value associated with this attribute.
  • Title: Accrual Start Date
    The date when the member starts accruing points from another member. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Member Name
    Read Only: true
    Maximum Length: 100
    This attribute shows information about the name of an individual household member under a defined house hold type member. This household member will receive accrual points. There is no default value, dependency, or limitation associated with this attribute.
  • The accrual type value. The Accrual Type depends on the MemberType attribute. If MemberType is set to Company, then AccrualType is Both. There is no default value or limitation associated with this attribute.
  • The first line of the member's address. The address information is based on the member type. If the MemberType attribute is set to Company, then the organization's address is displayed; and if MemberType is Household, then the corresponding household's address is displayed. There is no default value or limitation associated with this attribute.
  • The third line of the member's address. The address information is based on the member type. If the MemberType attribute is set to Company, then the organization's address is displayed; and if MemberType is Household, then the corresponding household's address is displayed. There is no default value or limitation associated with this attribute.
  • The second line of the member's address. The address information is based on the member type. If the MemberType attribute is set to Company, then the organization's address is displayed; and if MemberType is Household, then the corresponding household's address is displayed. There is no default value or limitation associated with this attribute.
  • Title: Approved by Employee's Identifier
    The employee identifier of the approving employee. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Approved Date
    The date when the changes to the current member record is approved. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Attribute Category
    Maximum Length: 30
    The attribute category. Do not use this attribute in the context of members. Oracle Loyalty Cloud does not currently support this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Child Number
    The child member, if any, is shown in this attribute. If the parent member is a corporate member, then the child member is also a corporate member. There is no default value, dependency, or limitation associated with this attribute.
  • The member's city. This attribute is dependent on the MemberType attribute. If the MemberType attribute is set to Company, then this attribute shows the organization's city. If MemberType is set to Household, then this attribute shows the household's city. There is no default value, dependency, or limitation associated with this attribute.
  • The first name of the member contact. A single Oracle Sales Cloud contact can be used to enroll into different programs. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Contact ID
    The contact identifier as specified in the Member Contacts object. There is no default value, dependency, or limitation associated with this attribute.
  • The last name of the member contact. A single Oracle Sales Cloud contact can be used to enroll into different programs. There is no default value, dependency, or limitation associated with this attribute.
  • The member contact's middle name. A single Oracle Sales Cloud contact can be used to enroll into different programs. Generally ContactLastName and ContactFirstName are used to enroll a single contact into different programs. There is no default value, dependency, or limitation associated with this attribute.
  • The name of the contact associated with the member. This attribute has the format of ContactFirstName ContactLastName. There is no default value, dependency, or limitation associated with this attribute.
  • 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.
  • 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 feature and is not currently used. There is no default value, dependency, or limitation associated with this attribute.
  • The country to which the member or organization belongs. If the value of the MemberType attribute is Company, then the home country of the organization is displayed. If the value of MemberType is Household, then the corresponding household's country is displayed. There is no default value or limitation associated with this attribute.
  • The county to which the member or organization belongs. If the value of the MemberType attribute is Company, then the home county address of the organization is displayed. If the value of MemberType is Household, then the corresponding household's county is displayed. There is no default value. County is dependent on MemberType Attribute. There is no limitation associated with this attribute.
  • 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.
  • 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. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Currency
    Maximum Length: 15
    The International currency code used by the member to complete transactions. International codes such as USD, INR,GBP are valid for this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • 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.
  • Title: Date of Birth
    The date when the member is born. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Descriptive Text
    Maximum Length: 250
    The description text that provides information about the member. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Display Sequence
    The display sequence to track the member's order in the UI. There is no default value, dependency, or limitation associated with this attribute.
  • The email address of the member. While creating a member under a program, the EmailAddress attribute gets written to the Contact information, which is further used to recognize the contact. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Expiry Date
    The date when the member's membership expires in a program. This is an optional attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Home Airport
    Maximum Length: 30
    The home airport. This attribute specifies a member's preference for the member's home airport. There is no default value, dependency, or limitation associated with this attribute.
  • The household member number. If the MemberType 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.
  • The household member name. If the MemberType 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.
  • Title: Incomplete Flights
    Maximum Length: 1000
    The details of an incomplete flight indication for members, if any. There is no default value, dependency, or limitation associated with this attribute.
  • The member's job title information. This is an optional attribute for the member's job designation, which is provided while enrolling a new member into a program. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Accrual Transaction Date
    The date when the last accrual transaction occurs. This date is set to the member's last accrual transaction. There is no default value, dependency, or limitation associated with this attribute.
  • 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.
  • Title: Last Transaction Processed Date
    The last transaction process date. This date shows when the last transaction was performed by the member. There is no default value, dependency, or limitation associated with this attribute.
  • 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.
  • 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.
  • 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 higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute.
  • 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 higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute.
  • 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 higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute.
  • 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 higher watermark of the Member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute.
  • 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 higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute.
  • 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 higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Title: Lounge Buy
    Maximum Length: 30
    The airport lounge buying code, which is the lounge buy code provided while making a purchase at a lounge in an airport. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Lounge Buy End Date
    The date when the lounge buy code is no longer valid for the member to make a purchase at the airport lounge. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Lounge Buy Start Date
    The date when the lounge buy code is valid for the member to make a purchase at the airport lounge. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Lounge
    Maximum Length: 30
    The lounge code for the airport, which is used to identify the lounge. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Lounge End Date
    The date when the member's access to the airport lounge ends. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Lounge Number
    Maximum Length: 100
    The lounge number which identifies the airport lounge. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Lounge Start Date
    The date when the member can access the airport lounge. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Loyalty Statement Date
    The date when the last loyalty statement for the member has been generated. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Loyalty Member ID
    The primary key identifier for the member. Oracle Loyalty Cloud generates this attribute value when it creates a member. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Loyalty Statement ID
    The last statement identifier, which is used to track the last loyalty statement for a member. There is no default value, dependency, or limitation associated with this attribute.
  • 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.
  • Title: Maximum Point Loan
    The maximum point loan. This value shows the limit of points that a member can receive as a loan. There is no default value or dependency on any other attributes.
  • Title: Maximum Point Status Code
    Maximum Length: 30
    The status of the maximum loan for the member. Possible values are Approved, Not approved and Rejected. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Maximum Point Type ID
    The maximum point type identifier. The identifier of the point type for which the Member has a maximum point balance. Oracle Loyalty Cloud does not use this attribute which is a carryover from the Oracle Siebel CRM product. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Member Attributes
    Title: (Deprecated) Member Attributes
    The member attribute resource is used to retrieve the details of a member attribute associated with the loyalty member.
  • The current class of the 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.
  • (Deprecated) Member Contacts
    Title: (Deprecated) Member Contacts
    The member contact resource is used to retrieve the details of a contact that is associated with the loyalty member.
  • The member group. This is an extended lookup type attribute of type ORA_LOY_MEM_GRP. This attribute shows information about the current group of Member. There is no default value or limitation associated with this attribute.
  • Title: Member Name
    Maximum Length: 100
    The name of the member, which can be provided as input while creating a member through the resource. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Member Number
    Maximum Length: 30
    The member number. This attribute is an alternative identifier for a member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute.
  • The current phase that the member is in. This has an extended lookup associated with ORA_LOY_MEM_PHASE. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Member Promotion Attributes
    Title: (Deprecated) Member Promotion Attributes
    The member promotion attribute resource is used to retrieve the details of a member promotion attribute associated with the loyalty member.
  • (Deprecated) Member Promotions
    Title: (Deprecated) Member Promotions
    The member promotion resource is used to retrieve the details of a promotion enrolled by the loyalty member.
  • (Deprecated) Member Referrals
    Title: (Deprecated) Member Referrals
    The member referral resource is used to retrieve the contacts that are referred by the loyalty member.
  • Title: Membership Scheme ID
    The unique reference to the member scheme, if any, chosen by the user while enrolling into the program. The member scheme can be a paid or free scheme. For example, a 6 months free membership, or a one year $5 paid membership, and so on. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Member Tiers
    Title: (Deprecated) Member Tiers
    The member tier resource is used to retrieve the member tier details for a loyalty member.
  • (Deprecated) Member Transactions
    Title: (Deprecated) Member Transactions
    The transaction resource is used to retrieve the details of transactions performed by the loyalty member.
  • The membership type of the member. This attribute is a list of value finder lookup of type ORA_LOY_MEM_TYPE. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Member Vouchers
    Title: (Deprecated) Member Vouchers
    The member voucher resource is used to retrieve the vouchers that are assigned to a loyalty member.
  • The mobile number of the member. This attribute can be provided as input when enrolling a member into a program. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Object Version Number
    The member object version number. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Organization Group ID
    The organization group identifier to which the member belongs. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Parent
    Maximum Length: 1
    Default Value: N
    The parent member where the member is either a household or an individual type, but is also a corporate member. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Parent Member ID
    The parent member identifier. This attribute indicates the corporate member to which the currently member belongs. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Registry ID
    Read Only: true
    Maximum Length: 30
    The loyalty partner number. Oracle Loyalty Cloud stores this number when a membership is created through a partner as a reference. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The phone number of the member. This is one of the Member Contact fields which can be used while enrolling a member in a program. There is no default value, dependency, or limitation associated with this attribute.
  • Title: PIN Number
    The postal index number of the member. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Name of Passenger Name Record
    Maximum Length: 26
    The PNR (passenger name record) name to be used for the member. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Member Point Balances
    Title: (Deprecated) Member Point Balances
    The point balance resource is used to retrieve the point balance detail for a loyalty member.
  • The available points for the member from Point Type A as defined in the 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.
  • The future points for the member from Point Type A as defined in the program. These points are added to the available points of the member on the date when the points are in effect. 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.
  • Title: Point Type A Value
    Default Value: 0
    The points for the member from Point Type A as defined in the 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.
  • The available points for the member from Point Type B as defined in the 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.
  • The future points for the member from Point Type B as defined in the program. These points are added to the available points of the member on the date when the points are in effect. 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.
  • Title: Point Type B Value
    Default Value: 0
    The points for the member from Point Type B as defined in the 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.
  • The available points for the member from Point Type C as defined in the 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.
  • The future points for the member from Point Type C as defined in the program. These points are added to the available points of the member on the date when the points are in effect. 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.
  • Title: Point Type C Value
    Default Value: 0
    The points for the member from Point Type C as defined in the 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.
  • The available points for the member from Point Type D as defined in the 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.
  • The future points for the member from Point Type D as defined in the program. These points are added to the available points of the member on the date when the points are in effect. 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.
  • Title: Point Type D Value
    Default Value: 0
    The points for the member from Point Type D as defined in the 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.
  • The available points for the member from Point Type E as defined in the 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.
  • The future points for the member from Point Type E as defined in the program. These points are added to the available points of the member on the date when the points are in effect. 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.
  • Title: Point Type E Value
    Default Value: 0
    The points for the member from Point Type E as defined in the 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.
  • The available points for the member from Point Type F as defined in the 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.
  • The future points for the member from Point Type F as defined in the program. These points are added to the available points of the member on the date when the points are in effect. 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.
  • Title: Point Type F Value
    Default Value: 0
    The points for the member from Point Type F as defined in the 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.
  • The available points for the member from Point Type G as defined in the 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.
  • The future points for the member from Point Type G as defined in the program. These points are added to the available points of the member on the date when the points are in effect. 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.
  • Title: Point Type G Value
    Default Value: 0
    The points for the member from Point Type G as defined in the 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.
  • The available points for the member from Point Type H as defined in the 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.
  • The future points for the member from Point Type H as defined in the program. These points are added to the available points of the member on the date when the points are in effect. 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.
  • Title: Point Type H Value
    Default Value: 0
    The points for the member from Point Type H as defined in the 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.
  • The member postal code. If the MemberType attribute is set to Household, then this attribute shows the postal code of the household member, and if MemberType is set to Company, then this attribute shows the postal code of the referenced organization. PostcalCode is dependent on the MemberType attribute. There is no default value or limitation associated with this attribute.
  • Title: Primary Address Identification
    The partner address identifier. If there is a partner record that is enrolled to a program as a member, then the primary address identifier is used as the partner's address. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Primary Contact ID
    The partner contact identifier. This value can be provided as an input while creating a member through the resource and when Oracle Loyalty Cloud enrols the corresponding contact as a member in the program.
  • Title: Primary Dominant Tier Identification
    The partner dominant tier identifier. This identifier is internal to Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Preferred Common Method
    Maximum Length: 30
    The preferred method for communicating loyalty information to the member. For example, email, phone, and so on. There is no default value, dependency, or limitation associated with this attribute.
  • The member's prefix, used when addressing the member. For example, Mr., Mrs., Sir, and so on. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Program Name
    The name of the program in which the member has been enrolled. The program name is given as an input when creating the member through the resource. There is no default value, dependency, or limitation associated with this attribute.
  • The member's province. If the MemberType attribute is set to Household, then this attribute shows the province of the household member and if MemberType is set to Company, then the attribute shows the province of the referenced organization. Province is dependent on the MemberType attribute. There is no default value or limitation associated with this attribute.
  • Title: Primary Position Identification Number
    The partner position identifier shows information about a partner that is enrolled as a member into a program. This is an external identifier from Oracle Sales Cloud. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Receive Promotion
    Maximum Length: 1
    Default Value: N
    The receiver promotion shows yes or no values which specify whether the promotion is applicable to this member. The default value is N. There is no dependency or limitation associated with this attribute. Oracle Loyalty Cloud does not currently support this attribute.
  • Title: Receive Partner Promotion
    Maximum Length: 1
    Default Value: N
    The receiver partner promotion signifies whether the member is eligible for a partner promotion or not. The default value is N. There is no dependency or limitation associated with this attribute.
  • Title: Referred by ID
    The member Identifier who has referred the current member to the program. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Referred by Number
    The member number of the member that has referred the current member to the 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.
  • Title: Regular Channel Code
    Maximum Length: 30
    The regular channel code. The member acquisition occurs through different sources or channels. This attribute is not currently used in Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Relationship ID
    The relationship identifier which shows the relationship between members. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Root Member ID
    The root member of member hierarchy. For example, if a member is part of an organization, then the root member is the head of the organization. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Joining Date
    The date when the membership in the program starts. There is no default value, dependency, or limitation associated with this attribute.
  • The member state. If the MemberType attribute is set to Household, then this attribute shows the state of the household member and if MemberType is set to Company, then the attribute shows the state of the referenced organization. State is dependent on the MemberType attribute. There is no default value or limitation associated with this attribute.
  • The status of the member. 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.
  • Title: Statement Method
    Maximum Length: 30
    The statement method code. This is an internal code which is used for identifying the loyalty statement for a given member. The method by which the member prefers to receive the loyalty statement. For example, email, mail, or SMS. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Statement Types
    Maximum Length: 30
    The statement type code for the loyalty statement which indicates the statement type. There is no default value, dependency, or limitation associated with this attribute. Oracle Loyalty Cloud does not currently support this attribute.
  • Title: Submit Date
    The date when the member record is submitted for approval. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Submit to Employee ID
    The identifier of the employee that submitted a new member record for approval. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Suppress Call
    Maximum Length: 1
    Default Value: N
    The attribute indicates that the member does not want to receive any calls pertaining to the ongoing promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute.
  • Title: Suppress Email
    Maximum Length: 1
    Default Value: N
    The attribute indicates that the member does not want to receive any emails pertaining to the ongoing promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute.
  • Title: Suppress Fax
    Maximum Length: 1
    Default Value: N
    The attribute indicates that the member does not want to receive any fax pertaining to the ongoing promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute.
  • Title: Suppress Mail
    Maximum Length: 1
    Default Value: N
    The attribute indicates that the member does not want to receive any mail pertaining to the ongoing promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute.
  • Title: Suppress SMS
    Maximum Length: 1
    Default Value: N
    The attribute indicates that the member does not want to receive any SMS messages pertaining to the ongoing promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute.
  • Title: Surviving Member ID
    The survival member identifier is the field which stores the detail of the survivor member identifier for a member merge. When a member merge is performed, only one member from the list is a survivor member and the remaining are victim members. This field stores the detail of survivor members in a victim member record. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The tier name of the current tier of the member. The tier calculation is done by the Oracle Loyalty Cloud engine. This attribute value gets set by the Oracle Loyalty Cloud engine when it assesses the tier of a member based on the qualifying point balance of the member. There is no default value, dependency, or limitation associated with this attribute.
  • The member's URL. This value shows any URLs to access a particular member. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Life Time Value Score
    Maximum Length: 50
    The life time value score of the member as the highest watermark value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Value Score
    Maximum Length: 30
    The value score of the member. There is no default value, dependency, or limitation associated with this attribute. Oracle Loyalty Cloud does not currently support this attribute.
  • The work phone number of the 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 : (Deprecated) Member Attributes
Type: array
Title: (Deprecated) Member Attributes
The member attribute resource is used to retrieve the details of a member attribute associated with the loyalty member.
Show Source
Nested Schema : (Deprecated) Member Contacts
Type: array
Title: (Deprecated) 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 : (Deprecated) Member Promotion Attributes
Type: array
Title: (Deprecated) Member Promotion Attributes
The member promotion attribute resource is used to retrieve the details of a member promotion attribute associated with the loyalty member.
Show Source
Nested Schema : (Deprecated) Member Promotions
Type: array
Title: (Deprecated) Member Promotions
The member promotion resource is used to retrieve the details of a promotion enrolled by the loyalty member.
Show Source
Nested Schema : (Deprecated) Member Referrals
Type: array
Title: (Deprecated) Member Referrals
The member referral resource is used to retrieve the contacts that are referred by the loyalty member.
Show Source
Nested Schema : (Deprecated) Member Tiers
Type: array
Title: (Deprecated) Member Tiers
The member tier resource is used to retrieve the member tier details for a loyalty member.
Show Source
Nested Schema : (Deprecated) Member Transactions
Type: array
Title: (Deprecated) Member Transactions
The transaction resource is used to retrieve the details of transactions performed by the loyalty member.
Show Source
Nested Schema : (Deprecated) Member Vouchers
Type: array
Title: (Deprecated) Member Vouchers
The member voucher resource is used to retrieve the vouchers that are assigned to a loyalty member.
Show Source
Nested Schema : (Deprecated) Member Point Balances
Type: array
Title: (Deprecated) Member Point Balances
The point balance resource is used to retrieve the point balance detail for a loyalty member.
Show Source
Nested Schema : loyaltyMembers-MemberAttributes-item-response
Type: object
Show Source
  • Title: Attribute Definition ID
    The member attribute definition identifier. This attribute is not part of the Oracle Loyalty Cloud Member resource. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Display Name
    Read Only: true
    Maximum Length: 30
    The name of the member attribute. It shows the display name of the Member level attribute which is created through the loyalty UI. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Conflict ID
    Default Value: 1
    The member attribute record conflict identifier. This attribute is an Oracle Siebel CRM feature which is replicated in Oracle Loyalty Cloud. It is not applicable to the current release and is set to 0 (zero) for most Oracle Loyalty Cloud entities. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user that creates the member attribute record. Oracle Loyalty Cloud populates this value when the loyalty administrator creates the Member level attributes in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Created Date
    Read Only: true
    The date when the member attribute record is created. Oracle Loyalty Cloud sets this date value when the loyalty administrator creates the Member level attributes in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Description
    Read Only: true
    Maximum Length: 1000
    The member attribute description text that is provided by the loyalty administrator while creating the Member level attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Update Date
    Read Only: true
    The member attribute 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 level attribute in the UI. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The member attribute record last updated by the user. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the Member level attribute in the UI. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The member attribute record 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 Member level attribute in the UI. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Title: Attribute Definition ID
    Read Only: true
    The attribute definition identifier. This attribute is the internal representation of the Member level attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Loyalty Attribute ID
    The attribute identifier, which is the reference definition identifier of Member Level attributes that are linked in the Member UI page. Do not use this attribute. It is exposed in the resource for reference purpose only. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Member ID
    The member identifier for the member level attributes applied to an individual member for the current member record. The MemberId attribute in the MemberAttributes child resource shows that the member level attribute is applied to this current member parent record. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Object Version Number
    The member attribute record object version number. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Promotion ID
    Read Only: true
    The promotion identifier which is applied when the Oracle Loyalty Cloud engine processes a Member level attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Attribute 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 promotions which updates the value of attribute. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyaltyMembers-MemberContacts-item-response
Type: object
Show Source
  • Title: Date of Birth
    Read Only: true
    The date when the member contact is born. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Primary Email
    Read Only: true
    Maximum Length: 320
    The email address of the member contact. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Primary Phone
    Read Only: true
    The phone number of the member contact. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Read Only: true
    The member contact identifier. The primary Identifier for referring a Oracle Sales Cloud contact who is enrolled as a member in a program. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The member identifier. The member reference identifier for the current contact under the Member service. This gives more information about contact related to current member. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    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.
  • 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 member to a program. There is no default value, dependency, or limitation associated with this attribute.
  • 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 member to a program. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyaltyMembers-MemberPromotionAttributes-item-response
Type: object
Show Source
  • 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.
  • Read Only: true
    Maximum Length: 30
    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
  • Read Only: true
    The member promotion attribute definition identifier. This attribute is the internal representation of the Member Promotion level attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 30
    The member number, which is an alternative key to identify a member, and is shown along with the promotion attributes created at the Member level. This attribute is used to show the member to which the promotion attributes were applied. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 30
    The order number associated with the transaction, which is used in the Retail industry for tracking multiple line items placed in an order. In order based promotions, this attribute is used to provide additional rewards to members when purchasing items in an order. There is no default value, dependency, or limitation associated with this attribute.
  • 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.
  • Read Only: true
    Maximum Length: 255
    The promotion attribute promotion name that shows the information regarding the promotion for which the Promotion level attributes are applied by the Oracle Loyalty Cloud engine. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 80
    The promotion attribute status that shows the processing status of 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.
  • Read Only: true
    Maximum Length: 250
    The promotion attribute value after the Oracle Loyalty Cloud engine updates the Promotion level attribute value based on bucket processing, or by applying promotions which updates the value of attribute. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyaltyMembers-MemberPromotions-item-response
Type: object
Show Source
  • Title: Active
    Read Only: true
    Maximum Length: 1
    The active status of the member promotion enrollment. The member might be enrolled in a promotion in the past and also in the future. For a current record, if this flag is true. then the enrollment of the member into an enrollable Promotion is active. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Member Enrollment End Date in Promotion.
    The date when the promotion enrollment ends. A member can be enrolled into a particular promotion until this date. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Promotion Enrollment Date
    The date when the promotion enrollment begins. A member can be enrolled into a particular promotion beginning on this date. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Title: Loyalty Promotion Member ID
    The promotion member identifier, which is the primary identifier to uniquely identify a member enrolled into a promotion for a given period. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Member Number
    The member number, which is an alternative key to identify a member, and is shown along with the promotion name while 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.
  • Title: Object Version Number
    The member promotion enrollment object version number. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Promotion Name
    The promotion name which is has the enrollable promotion flag enabled and for which the enrollment start and end date is specified for the current member. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The 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.
  • Read Only: true
    The 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.
Nested Schema : loyaltyMembers-MemberReferrals-item-response
Type: object
Show Source
  • Title: Contact ID
    Read Only: true
    The contact identifier of the member referral. This is the contact information of the member who is referred by the current top level member resource. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Title: Loyalty Member ID
    Read Only: true
    The member identifier of the member that referred the current member to the program. A single member can refer multiple members to a single program. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Member Number
    Read Only: true
    Maximum Length: 30
    The MemNumber attribute in the child MemberReferrals resource shows the member number of the member to whom the parent member refers to in a program. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Member Type
    Read Only: true
    Maximum Length: 30
    The member type of the member referral. That is, the type of membership that is held by the current member child referral record. Example values are ORA_MEM_TYPE_INDIVIDUAL, ORA_MEM_TYPE_COMP, and ORA_MEM_TYPE_HOUSEHOLD. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Member Name
    Read Only: true
    Maximum Length: 100
    The name of the member referral. When a single member refers other multiple members to a program, then the Name attribute in child MemberReferrals shows the referred member names. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Referred by ID
    Read Only: true
    The referred by identifier of the member referral. The child MemberReferral resource shows information on the parent members that referred the child members. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Status
    Read Only: true
    Maximum Length: 30
    The status code of the member referral. This shows the status of the member that is referred to program, for example, Active or Inactive. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyaltyMembers-MemberTiers-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 1
    The active status of the member tier, which shows the current active tier to which a member belongs. Because the member might be promoted from a lower tier, there might be multiple records which show the tiers related to the member. For example, a member initially in a silver tier might be promoted to a gold tier. In this case, there are two tier records related to the member, one for gold which is active, and another for silver which is not active. There is no default value, dependency, or limitation associated with this attribute.
  • 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.
  • Title: Tier Name
    Read Only: true
    Maximum Length: 30
    The current tier of the member, which displays the information about which tier the member currently belongs to. Because the member might be promoted from a lower tier, there might be multiple records which show the tiers that are related to the member. For example, a member initially in a silver tier might be promoted to a gold tier. In this case, there are two tier records related to the member, one for gold which is active, and another for silver which is not active. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The date when the member tier ends. The member is active in a particular member tier until this date. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • 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.
  • Read Only: true
    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.
  • Read Only: true
    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.
  • Read Only: true
    The member tier identifier. The 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 Member Id with MemberTierId as the unique identifier. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The identifier of the possible tier 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.
  • Read Only: true
    Maximum Length: 30
    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.
  • Read Only: true
    The present qualifying point balance for the member. Oracle Loyalty Cloud calculates this attribute value based on the point balance of the member. This attribute provides information about the current balance. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The qualifying points required to upgrade to the next tier. For example, if the present qualifying balance for the member is 100 points and the current tier is Silver, then 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.
  • Read Only: true
    Maximum Length: 250
    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 members have their tier changed. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The date when the member tier starts. For example, if the 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 the member belonged to that particular tier. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Tier Class Name
    Read Only: true
    Maximum Length: 30
    The tier class name. In member tier records, for each tier to which the member belongs, 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.
  • Read Only: true
    The tier qualifying points threshold, which is the minimum qualifying points required to achieve the current tier for a member. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The date until 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 : loyaltyMembers-MemberTransactions-item-response
Type: object
Show Source
  • Links
  • Title: Loyalty Transaction ID
    Read Only: true
    The transaction identifier of the transaction. This attribute is the primary key identifier for a loyalty transaction. This loyalty transaction is shown as read-only child of the Members resource. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Member ID
    Read Only: true
    The member reference identifier for the current transaction child records, which provides information about the current parent member transactions. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Partner ID
    Read Only: true
    The partner identifier of the transaction, which is shown for the partner transaction data. This attribute is shown and used in mobile UIs and other integrations. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Product ID
    Read Only: true
    The product identifier of the transaction, which is used in mobile UIs or other integrations that are build on the Oracle Loyalty Cloud resources. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Status Code
    Read Only: true
    Maximum Length: 30
    The status code of the transaction. The transaction status shown in a finder lookup code value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Subtype Code
    Read Only: true
    Maximum Length: 30
    The subtype code of the transaction shown as a finder lookup code. This is dependent on the TypeCode attribute. There is no default value or limitation associated with this attribute.
  • Title: Transaction Date
    Read Only: true
    The transaction date when the transaction occurs. In the child MemberTransactions child resource under the loyaltyMembers resource, the TransactionDate shows the date when the loyalty transaction is performed by the particular parent member. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transaction Number
    Read Only: true
    Maximum Length: 30
    The transaction number of the transaction. This is an alternative identifier for transactions, and is displayed in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Type Code
    Read Only: true
    Maximum Length: 30
    The type code of the transaction. The transaction type code is shown in a finder lookup code value. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyaltyMembers-MemberVouchers-item-response
Type: object
Show Source
  • Title: Currency Amount
    Read Only: true
    The voucher currency amount for the member voucher. This attribute is dependent on the VoucherDiscountType attribute. If Voucher Discount Type is an absolute value, then the CurrencyAmount attribute displays the absolute value of the voucher. There is no default value. CurrencyAmount is dependent on Voucher Discount Type. There is no limitation associated with this attribute.
  • Title: Discount Percentage
    Read Only: true
    The voucher discount percent. This attribute is required if the DiscountType attribute is set to Percentage and depends on the DiscountType attribute setting which is input by the user when creating a voucher. There is no default value or limitation associated with this attribute.
  • Title: Expiration Date
    Read Only: true
    The date when the member voucher expires. Oracle Loyalty Cloud sets this value while creating a voucher record. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Title: Member Voucher ID
    Read Only: true
    The primary key to identify a voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Member ID
    Read Only: true
    The Identity of the member for the assigned voucher. Oracle Loyalty Cloud assigns this attribute value when it assigns a voucher action or is set indirectly by deriving MemberId from the MemberNumber attribute which is input when creating voucher using the resource. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The identity of the product for an existing voucher. Although its not a best practice to expose the identifier of a product, this attribute is used for building mobile UIs and drop downs, and provides information on the product in use. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Quantity
    Read Only: true
    The quantity of vouchers assigned to a member. The value is a positive integer. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Loyalty Transaction ID
    Read Only: true
    The transaction identifier of the transaction. This attribute is the primary key identifier for a loyalty transaction. This loyalty transaction is shown as a read-only child of the Member Vouchers resource. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transaction Number
    Read Only: true
    Maximum Length: 30
    The transaction number of the transaction. This is an alternative identifier for a transaction, and is displayed in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Voucher Effective Start Date
    Read Only: true
    The date when the voucher is in effect. This date is set 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.
  • Title: Voucher Number
    Read Only: true
    Maximum Length: 30
    The alternative way to identify a voucher. The UI shows the voucher number. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The text that defines the voucher status. This is a read-only value that shows the meaning of the Voucher Status Code LOV values such as Available, Used, Cancelled and Expired. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The loyalty product description for the voucher. 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.
Nested Schema : loyaltyMembers-PointBalances-item-response
Type: object
Show Source
  • Read Only: true
    The point balance. This attribute is the numeric value of the point balance of the point type. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The member's remaining points, which are available for future use and on maturity are added into the member's available balance. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The member's lifetime point balance, which is the high watermark of the member's point balance. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Read Only: true
    The attribute definition identifier of the point balance. This attribute is the internal identifier for Point Type definition. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The member identifier of the point balance. This attribute is the member's primary key identifier for which the point balance is displayed. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 255
    The point type of the point balance. The point balance is displayed as a child resource under the loyalty Members resource. A member can have a point balance related to multiple point types. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The member qualifying point balance. Oracle Loyalty Cloud uses the qualifying point type's point balance for tier assessment. There is no default value, dependency, or limitation associated with this attribute.
Links
MemberAttributes
Parameters:
  • MemberNumber: $request.path.MemberNumber
The member attribute resource is used to retrieve the details of a member attribute associated with the loyalty member.
MemberContacts
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.
MemberPromotionAttributes
Parameters:
  • MemberNumber: $request.path.MemberNumber
The member promotion attribute resource is used to retrieve the details of a member promotion attribute associated with the loyalty member.
MemberPromotions
Parameters:
  • MemberNumber: $request.path.MemberNumber
The member promotion resource is used to retrieve the details of a promotion enrolled by the loyalty member.
MemberReferrals
Parameters:
  • MemberNumber: $request.path.MemberNumber
The member referral resource is used to retrieve the contacts that are referred by the loyalty member.
MemberTiers
Parameters:
  • MemberNumber: $request.path.MemberNumber
The member tier resource is used to retrieve the member tier details for a loyalty member.
MemberTransactions
Parameters:
  • MemberNumber: $request.path.MemberNumber
The transaction resource is used to retrieve the details of transactions performed by the loyalty member.
MemberVouchers
Parameters:
  • MemberNumber: $request.path.MemberNumber
The member voucher resource is used to retrieve the vouchers that are assigned to a loyalty member.
PointBalances
Parameters:
  • MemberNumber: $request.path.MemberNumber
The point balance resource is used to retrieve the point balance detail for a loyalty member.
Back to Top

Examples

This example shows the search request and the response payload when searching for member number 300000065914078, which you created in the High Miles program.

Use GET with the following URI syntax to search for the member:
https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers?finder=MemberSearch;MemberNumber=300000065914078

Example of Response Header

Cache-Control -no-cache, no-store, must-revalidate
Connection -keep-alive
Content-Encoding -gzip
Content-Language -en
Content-Length -1196
Content-Type -application/vnd.oracle.adf.resourcecollection+json
Date -Fri, 23 Dec 2016 14:48:43 GMT
Link -<https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers>;rel="self";kind="collection";name="loyaltyMembers"
Location -
REST-Framework-Version -1
Server -Oracle-HTTP-Server-11g
Vary -Accept-Encoding
X-ORACLE-DMS-ECID -005H5HvVPcS5Qdv_GXl3if0002Es000968

Example of Response Body

{
  "items" : [ {
    "LoyMemberId" : 300000065914077,
    "MemberName" : "John Doh",
    "ProgramName" : "High Miles",
    "LftmPointTypeFVal" : null,
    "LftmPointTypeHVal" : null,
    "LoungeStartDt" : null,
    "CorpCurrencyCode" : null,
    "AccrualType" : null,
    "LoungeBuyEndDt" : null,
    "CurcyConvRateType" : null,
    "IncompleteFlights" : null,
    "ContactId" : null,
    "MaximumPointStatCode" : null,
    "LoungeCode" : null,
    "CurrencyDate" : null,
    "AccrualToMemberId" : null,
    "LoungeBuyCode" : null,
    "MemberPhaseCode" : null,
    "LastAccrTransactionDt" : "2016-12-23T14:37:06+00:00",
    "LftmPointTypeBVal" : null,
    "HomeAirport" : null,
    "AttributeCategory" : null,
    "LftmPointTypeGVal" : null,
    "LastRdmTransactionDt" : null,
    "LftmPointTypeEVal" : null,
    "CurrencyCode" : null,
    "AccountId" : null,
    "LoyLstStmtDt" : null,
    "ExpiryDate" : null,
    "DescriptionText" : null,
    "MembershipSchemeId" : null,
    "LastTransactionProcedDt" : "2016-12-23T14:37:06+00:00",
    "MemberNumber" : "300000065914078",
    "LftmPointTypeAVal" : 300,
    "ChildNumber" : null,
    "AccrualStartDate" : null,
    "LoungeNumber" : null,
    "LftmPointTypeDVal" : null,
    "DisplaySequence" : null,
    "MemberGrpCode" : null,
    "LoungeBuyStartDt" : null,
    "MemberTypeCode" : "Individual",
    "CorpMemberNumber" : null,
    "LoungeEndDate" : null,
    "ApprovalDate" : null,
    "LstStmtId" : null,
    "LstTierChangeDt" : null,
    "MaximumPointLoan" : null,
    "LftmPointTypeCVal" : null,
    "ApprByEmployeeId" : null,
    "MemberClassCode" : null,
    "MaximumPointTypeId" : null,
    "OrgGroupId" : null,
    "ParMemberId" : null,
    "ParentMember" : "N",
    "PINNumber" : null,
    "PnrName" : null,
    "PointTypeAVal" : 300,
    "PointTypeBVal" : 0,
    "PointTypeCVal" : 0,
    "PointTypeDVal" : 0,
    "PointTypeEVal" : 0,
    "PointTypeFVal" : 0,
    "PointTypeGVal" : 0,
    "PointTypeHVal" : 0,
    "PrAddrId" : null,
    "PrConId" : 300000065914079,
    "PrDomTierId" : null,
    "PrPostnId" : null,
    "PreferCommMethCode" : null,
    "ReceivePromotion" : "N",
    "RecPtnrPromotion" : "N",
    "ReferredById" : 300000065301652,
    "RegChannelCode" : null,
    "RelationshipId" : null,
    "RootMemId" : null,
    "StartDate" : "2016-12-23T14:37:04+00:00",
    "StatusCode" : "Active",
    "StmtMthdCode" : null,
    "StmtTypeCode" : null,
    "SubmitDate" : null,
    "SubmitToEmployeeId" : null,
    "SuppressCall" : "N",
    "SuppressFax" : "N",
    "SuppressEmail" : "N",
    "SuppressSMS" : "N",
    "SuppressMail" : "N",
    "ValLifeScore" : null,
    "SurvMemberId" : null,
    "ValScore" : null,
    "ReferredByNumber" : null,
    "CreationSource" : null,
    "PartyId" : 300000065914079,
    "PersonProfileId" : 300000065914079,
    "TierName" : "Base",
    "DateOfBirth" : "1990-12-12",
    "MemberGroup" : null,
    "EmailAddress" : "john.doh@fakesite.com",
    "ContactName" : "John Doh",
    "ContactFirstName" : "John",
    "ContactLastName" : "Doh",
    "WorkPhoneNumber" : "123456789",
    "MobileNumber" : "67869866986",
    "PhoneNumber" : "+1 123456789",
    "links" : [ {
      "rel" : "self",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300000065914078",
      "name" : "loyaltyMembers",
      "kind" : "item"
    }, {
      "rel" : "canonical",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300000065914078",
      "name" : "loyaltyMembers",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300000065914078/child/Transaction",
      "name" : "Transaction",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300000065914078/child/PointBalance",
      "name" : "PointBalance",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300000065914078/child/MemberVoucher",
      "name" : "MemberVoucher",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300000065914078/child/MemberReferral",
      "name" : "MemberReferral",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300000065914078/child/MemberTier",
      "name" : "MemberTier",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300000065914078/child/MemberContact",
      "name" : "MemberContact",
      "kind" : "collection"
    } ]
  } ],
  "count" : 1,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers",
    "name" : "loyaltyMembers",
    "kind" : "collection"
  } ]
}
Back to Top