Required Attributes and Path Parameters for Request Payloads
For the Loyalty REST API, you use request payloads for POST and PATCH methods. The request payloads must include the required attributes when using the POST method. Similarly, the request URL must include the path parameters when using the POST and PATCH methods. The sections in this topic list the request payload attributes and path parameters for resources and their subresources.
- loyTransactions: Required Attributes and Path Parameters
- loyMembers: Required Attributes and Path Parameters
- loyPrograms: Required Attributes and Path Parameters
- loyPromotions: Required Attributes and Path Parameters
- loyaltyMembershipCards: Required Attributes and Path Parameters
- loyVouchers: Required Attributes and Path Parameters
loyTransactions: Required Attributes and Path Parameters
This section lists out the relevant attributes for the request payloads of loyTransactions resource and its child resources.
The following table shows the relation between the parent resource and its child resources.
Parent Level | loyTransactions |
Child Resources | AccrualItems |
RedemptionItems | |
Promotions | |
Promotions > PromotionAttributes | |
Vouchers |
The following table lists all the REST methods applicable to all loyTransactions resources.
Resource | HTTP Method Available |
---|---|
loyTransactions | GET PATCH POST DELETE |
loyTransactions > AccrualItems | GET |
loyTransactions > RedemptionItems | GET |
loyTransactions > Promotions | GET |
loyTransactions > Promotions> PromotionAttributes | GET |
loyTransactions > Vouchers | GET |
The following table lists the required attributes for the POST method for the loyTransaction resource, which enables the creation and processing of a transaction.
Resource | Attribute | Attribute Description |
---|---|---|
loyTransactions | ProgramName or ProgramNumber | The name or number of the program for which the transcation is created. |
TypeCode | The transaction type code name. | |
SubTypeCode | The transaction subtype name. | |
MemberNumber | The member for whom the transaction is created. | |
ProductNumber | The product that is used in the transaction.
Note: Conditional. This attribute is required when subTypeCode of the transaction is set to ORA_ACC_PROD or ORA_RED_PROD. |
The following table lists the required attributes for processing and cancelling a transaction using the POST method.
Resource | Attribute | Attribute Description |
---|---|---|
loyTransactions | name | The name of the action to be executed:
|
parameters > transactionNumber | The transaction number of the transaction to be processed or cancelled. |
Note:
- For processTransaction, the transaction must be in the
In Progress
state. - For cancelTransaction, the transaction must be in the
Processed
state.
The following table lists the path parameters required for the GET, PATCH and DELETE methods for loyTransactions.
Resource | Path | Path Parameters |
---|---|---|
loyTransactions | /crmRestApi/resources/11.13.18.05/loyTransactions/<TransactionId> | TransactionId |
Note:
- For an update action, a transaction must be in either a
Rejected
orIn Progress
state. - For a delete action, a transaction must be in an
In Progress
state.
The following table lists the path attributes required for the GET method for loyTransactions child resources.
Resource | Path | Path Parameters |
---|---|---|
loyTransactions > AccrualItems | /crmRestApi/resources/11.13.18.05/loyTransactions/<TransactionId>/child/AccrualItems | TransactionId |
loyTransactions > RedemptionItems | /crmRestApi/resources/11.13.18.05/loyTransactions/<TransactionId>/child/RedemptionItems | TransactionId |
loyTransactions > Promotions | /crmRestApi/resources/11.13.18.05/loyTransactions/<TransactionId>/child/Promotions | TransactionId |
loyTransactions > Promotions > PromotionAttributes | /crmRestApi/resources/11.13.18.05/loyTransactions/<TransactionId>/child/Promotions/<PromotionId>/child/PromotionAttributes | TransactionId PromotionId |
loyTransactions > Vouchers | /crmRestApi/resources/11.13.18.05/loyTransactions/<TransactionId>/child/Vouchers | TransactionId |
loyMembers: Required Attributes and Path Parameters
This sections lists the relevant attributes for the request payloads of loyMembers resource and its child resources.
The following table shows the relation between the parent resource and its child resources.
Parent Level | loyMembers |
Child Resources | MemberAttributes |
promotions | |
MemberContact | |
MemberReferrals | |
vouchers | |
PromotionAttributeDetail | |
MemberTransactions | |
MemberTier | |
cards | |
PointItems |
The following table lists all the REST methods applicable to all the LoyMembers resources.
Resource | HTTP Methods Available |
---|---|
loyMembers | GET POST PATCH |
loyMembers > MemberAttributes | GET |
loyMembers > promotions | GET POST |
loyMembers > MemberContact | GET |
loyMembers > MemberReferrals | GET |
loyMembers > vouchers | GET POST PATCH |
loyMembers > PromotionAttributeDetail | GET |
loyMembers > MemberTransactions | GET |
loyMembers > MemberTier | GET |
loyMembers > cards | GET POST PATCH |
loyMembers > PointItems | GET |
The following table lists the required attributes for the POST method on loyMembers resource when creating a member.
Resource | Attribute | Attribute Description |
---|---|---|
loyMembers | ContactFirstName | The first name and last name of the member. Note: At least one of these attributes has to be provided. |
ContactLastName | ||
LoyProgramName or ProgramNumber | The program for which member is to be created. |
Note:
The program for which the member is created must be active for member creation.The following table lists the required attributes for the POST
method on loyMembers for merging members.
Path | Attributes | Attribute Description |
---|---|---|
/crmRestApi/resources/11.13.18.05/ loyMembers | name | For merging mambers: name = "mergeMembers" |
parameters > survivingMemberNumber | Member Number of the member into which other members will be merged. | |
parameters > memberNumbersToBeMerged | List of all members which have to be merged into the surviving member. |
POST
method on loyMembers child resources.
Resource | Attribute | Attribute Description |
---|---|---|
loyMembers > promotions | PromotionName | |
loyMembers > vouchers | ProductNumber | |
ExpirationDt | ||
CurrencyAmount | ||
loyMembers > cards | ExpiryDate | |
NameOnCard | ||
CardType |
The following table lists the path parameters required for the GET
method for retrieving members.
Resource | Path | Path Parameters | Description |
---|---|---|---|
loyMembers > MemberAttributes | /crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/MemberAttributes | Member Number | Retrieves the list of member attributes under a member. |
loyMembers > promotions | /crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/promotions | Member Number | Retrieves all the promotions in which a member is enrolled. |
/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/promotions/<LoyPromomemId > | Member Number | Retrieves a specific promotion using the LoyPromomemId parameter. | |
LoyPromomemId | |||
loyMembers > MemberContact | /crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/MemberContact | Member Number | Retrieves the list of contacts under a member. |
loyMembers > MemberReferrals | /crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/MemberReferrals | Member Number | Retrieves the list of referrals under a member. |
loyMembers > vouchers | /crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/vouchers | Member Number | Retrieves the list of vouchers under a member. |
/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/vouchers/<VoucherNumber> | Member Number | Retrieves a specific voucher under a member. | |
Voucher Number | |||
/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/vouchers?finder=availableVoucherFinder | Member Number | Queries and lists all available vouchers for a member. | |
/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/vouchers?finder=availableVoucherFinder?finder=validateVoucherFinder;VoucherNumber=<VoucherNumber>, ActivityDate=<ActivityDate> | Member Number | Validates whether the voucher number provided is valid. The attribute 'validFlag' is 'true' if voucher is valid, and "False" if the voucher is invalid. | |
Voucher Number | |||
Activity Date | |||
loyMembers > PromotionAttributeDetail | /crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/PromotionAttributeDetail | Member Number | Retrieves a list of promotion attributes under a member. |
loyMembers > MemberTransactions | /crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/MemberTransactions | Member Number | Retrieves a list transactions under a member. |
loyMembers > MemberTier | /crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/MemberTier | Member Number | Retrieves a list of member tiers under a member. |
loyMembers > cards | /crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/cards | Member Number | Retrieves a list of membership cards under a member. |
/crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/cards/<LoyCardId> | Member Number | Retrieves a specific membership card for a member. | |
LoyCardId |
The following table lists the path parameters required for the PATCH
method for loyMembers child resources.
Resource | Path | Path Parameters | Description |
---|---|---|---|
loyMembers > vouchers | /crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/vouchers/<VoucherNumber> | Member Number | Updates the attributes of the voucher specified by the Voucher Number parameter. |
Voucher Number | |||
loyMembers > cards | /crmRestApi/resources/11.13.18.05/loyMembers/<MemberNumber>/child/cards/<LoyCardId> | Member Number | Updates attributes of the membership card specified by the LoyCardId parameter. |
LoyCardId |
loyPrograms: Required Attributes and Path Parameters
This section lists the relevant attributes for the request payloads of loyPrograms resource and its child resources.
The following table shows the relation between the parent resource and its child resources.
Parent Level | loyPrograms |
Child Resources | CalendarAttributes |
MemberAttributes | |
MemberFieldAttributes | |
MemberTierAttributes | |
NegativePoints | |
PointSubtypes | |
PointTotalsAttributes | |
PointTypes | |
ProgramPartners | |
RedemptionProducts | |
TierClasses | |
TransactionAttributes | |
TransactionRestrictions | |
PointBlocks | |
events | |
events > eventTransactionAttributes |
The following table lists all the REST methods applicable to loyPrograms resources.
Resource | HTTP Methods Available |
---|---|
loyPrograms | GET |
loyPrograms > CalendarAttributes | GET |
loyPrograms > MemberAttributes | GET |
loyPrograms > MemberFieldAttributes | GET |
loyPrograms > MemberTierAttributes | GET |
loyPrograms > NegativePoints | GET |
loyPrograms > PointSubtypes | GET |
loyPrograms >PointTotalsAttributes | GET |
loyPrograms > PointTypes | GET |
loyPrograms > ProgramPartners | GET |
loyPrograms > RedemptionProducts | GET |
loyPrograms > TierClasses | GET |
loyPrograms > TransactionAttributes | GET |
loyPrograms > TransactionRestrictions | GET |
loyPrograms > PointBlocks | GET POST |
loyPrograms > events | GET POST DELETE |
loyPrograms > events > eventTransactionAttributes | GET POST DELETE |
The following table lists how the GET
method can be used to retrieve programs.
Method Name | Path | Method Description |
---|---|---|
Finder Search | /crmRestApi/resources/11.13.18.05/loyPrograms?finder=ProgramSearch;Name=<ProgramName> | ProgramName can be used for finding the program. |
Query Search | /crmRestApi/resources/11.13.18.05/loyPrograms?q=Name LIKE <Keyword> | Individual attributes can be queried. |
ProgramId Search | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId> | ProgramId can be used to fetch the unique program. |
The following table lists the path attributes required for the GET
method for the loyPrograms child resources.
Resource | Path | Path Parameters |
---|---|---|
loyPrograms > CalendarAttributes | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/CalendarAttributes | ProgramId |
loyPrograms > MemberAttributes | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/MemberAttributes | ProgramId |
loyPrograms > MemberFieldAttributes | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/MemberFieldAttributes | ProgramId |
loyPrograms > MemberTierAttributes | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/MemberTierAttributes | ProgramId |
loyPrograms > NegativePoints | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/NegativePoints | ProgramId |
loyPrograms > PointSubtypes | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/PointSubtypes | ProgramId |
loyPrograms >PointTotalsAttributes | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/PointTotalsAttributes | ProgramId |
loyPrograms > PointTypes | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/PointTypes | ProgramId |
loyPrograms > ProgramPartners | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/ProgramPartners | ProgramId |
loyPrograms > RedemptionProducts | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/RedemptionProducts | ProgramId |
loyPrograms > TierClasses | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/TierClasses | ProgramId |
loyPrograms > TransactionAttributes | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/TransactionAttributes | ProgramId |
loyPrograms > TransactionRestrictionsl | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/TransactionRestrictions | ProgramId |
loyPrograms > PointBlocks | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/PointBlocks | ProgramId |
loyPrograms > events | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/events | ProgramId |
loyPrograms > events > eventTransactionAttributes | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/events/<eventId>/child/eventTransactionAttributes | ProgramId eventId |
The following table lists the required attributes for the POST
method on child attributes for LoyPrograms.
Resource | Attributes | Attribute Description |
---|---|---|
loyPrograms > PointBlocks | Partner | Name of partner |
OriginalPoints | ||
Name | Name of the PointBlocks item to be created. | |
loyPrograms > events | EventName | Name of the event that is to be created. |
MemberAttributeName | This must be the name of a member field attribute for the program. | |
loyPrograms > events > eventTransactionAttributes | TransactionAttrName | |
TransactionAttrValue |
The following table lists the path parameters for the DELETE
method on child attributes for LoyPrograms.
Resource | Path | Path Parameters |
---|---|---|
loyPrograms > events | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/events/eventId> | ProgramId eventId |
loyPrograms > events > eventTransactionAttributes | /crmRestApi/resources/11.13.18.05/loyPrograms/<ProgramId>/child/events/<eventId>/child/eventTransactionAttributes/<eventAttrId> | ProgramId eventId eventAttrId |
loyPromotions: Required Attributes and Path Parameters
This sections lists out the relevant attributes for the request payloads of the loyPromotions resource and its child resources.
The following table shows the relation between the parent resource and its child resources.
Parent Level | loyPromotions |
Child Resources | PromotionAttributes |
PromotionIncentiveChoices |
The following table lists the REST methods applicable to loyPromotions resources.
Resource | HTTP Methods Available |
---|---|
loyPromotions | GET |
loyPromotions > PromotionAttributes | GET |
loyPromotions > PromotionIncentiveChoices | GET |
The following table lists how the GET
method can be used to retrieve promotions.
Search Type | Path | Path Parameters |
---|---|---|
Get all promotions | /crmRestApi/resources/11.13.18.05/loyaltyPromotions | NULL |
Get promotions linked with a program | /crmRestApi/resources/11.13.18.05/loyaltyPromotions?q=ProgramName=<ProgramName> | ProgramName |
Get a particular promotion based on a PromotionId | /crmRestApi/resources/11.13.18.05/loyaltyPromotions/<LoyPromoId> | PromotionId |
The following table lists the path attributes required for the GET
method of loyPromotions child resources.
Resource | Path | Path Parameters |
---|---|---|
loyPromotions > PromotionAttributes | /crmRestApi/resources/11.13.18.05/loyPromotions/<LoyPromoId>/child/PromotionAttributes | PromotionId |
loyPromotions > PromotionIncentiveChoices | /crmRestApi/resources/11.13.18.05/loyPromotions/<LoyPromoId>/child/PromotionIncentiveChoices | PromotionId |
loyaltyMembershipCards: Required Attributes and Path Parameters
This section lists the relevant attributes and path parameters required by the loyaltyMembershipCards resource.
The following table lists the GET
method calls for fetching membership cards based on different criteria.
Search Method | Path | Path Parameters |
---|---|---|
MemberCardTypeSearch | /crmRestApi/resources/11.13.0.0/loyaltyMembershipCards?finder=MemberCardTypeSearch;CardType=<CardType>,MemberNumber=<MemberNumber> | Card Type (optional) |
Member Number (mandatory) | ||
MembershipCardSearch | /crmRestApi/resources/11.13.0.0/loyaltyMembershipCards?finder=MembershipCardSearch;MemberNumber=<MemberNumber>,NameOnCard=<NameOnCard> | Any attribute of loyaltyMembershipCards, except ExpiryStampedOnCard |
loyVouchers: Required Attributes and Path Parameters
This section lists the relevant attributes and path parameters required by the loyVouchers resource.
The following table lists the path parameters for the GET
function for loyVouchers.
Function | Path | Path Parameters |
---|---|---|
Available Vouchers | /crmRestApi/resources/11.13.18.05/loyVouchers?finder=availableVoucherFinder;MemberNumber=<MemberNumber>,ActivityDate=<ActivityDate> | MemberNumber |
ActivityDate | ||
Validate Vouchers | /crmRestApi/resources/11.13.18.05/loyVouchers?finder=validateVoucherFinder;VoucherNumber=<VoucherNumber>,ActivityDate=<ActivityDate> | VoucherNumber |
ActivityDate |
Note:
The Oracle Loyalty Cloud APIs in the following sections have been deprecated.Member API (deprecated)
The following table describes the methods and parameters for the Member API. Use the Member API to enroll a new member to Oracle Loyalty Cloud, search for an existing member, and obtain the details for a member by performing a membership inquiry.
Method Name | Purpose | Required Input Parameters | Optional Input Parameters | Output Parameters |
---|---|---|---|---|
MemberEnrollment | Enrolls a member into the specified loyalty program. |
|
|
Hierarchy of the Member details:
|
MemberUpdate | Updates member details. |
|
Any Member attribute in the Membership Data model. | Hierarchy of the Member details. |
MemberSearch | Searches and returns the membership number of the member. |
|
None | List of membership numbers |
MembershipInquiry | Retrieves the membership details for a given membership number. | Membership # |
|
Hierarchy of the Member details, such as:
|
Member Enrollment API (deprecated)
The following table describes the methods and parameters for the Member Enrollment API. Use the Member Enrollment API to search for Loyalty member tiers, and check the details of the promotions for which the member is enrolled
Method Name | Purpose | Required Input Parameters | Optional Input Parameters | Output Parameters |
---|---|---|---|---|
MemberInquiryChild ? MemberTiers | Searches for Loyalty Member Tiers which is a child of Member. |
|
None |
|
MemberInquiryChild ? MemberPromotions | Checks the details of the promotions for which the member is enrolled. |
|
None |
|
Membership Card API (deprecated)
The following table describes the methods and parameters for the Membership Card API. Use the Membership Card API to create and access membership cards in a oyalty program.
Method Name | Purpose | Required Input Parameters | Optional Input Parameters | Output Parameters |
---|---|---|---|---|
CreateMembershipCard | Creates a membership card with the specified details. |
|
|
Membership card details:
|
MembershipCardUpdate | Updates the membership card details. |
|
|
Membership card details:
|
MembershipCardInquiry | Checks membership card details for required information. |
|
|
Membership card details:
|
Product API (deprecated)
The following table describes the methods and parameters for the Product API. Use the Product API to access and query products associated with a loyalty program.
Method Name | Purpose | Required Input Parameters | Optional Input Parameters | Output Parameters |
---|---|---|---|---|
GetPrice | Retrieves price detail information for the product from the loyalty program. The price detail includes information such as the point type, the number of points, the currency, the payment mode, and so on. |
|
|
|
CheckCredit | Checks the point balance of a member against the selected product. |
|
|
|
Program API (deprecated)
The following table describes the methods and parameters for the Program API. Use the Program API to search for all loyalty programs that are running, and to obtain the details for a specific program by performing a program inquiry.
Method Name | Purpose | Required Input Parameters | Optional Input Parameters | Output Parameters |
---|---|---|---|---|
ProgramsInquiry | Retrieves all loyalty program details for a loyalty instance. | None | Program Name |
|
GetProgramDetail | Retrieves the details for a specific loyalty program. | Program Name | None |
|
Promotion API (deprecated)
The following table describes the methods and parameters for the Promotion API. Use the Promotion API to search for loyalty promotions, and to obtain the details for a specific promotion by performing a promotion inquiry.
Method Name | Purpose | Required Input Parameters | Optional Input Parameters | Output Parameters |
---|---|---|---|---|
PromotionsInquiry | Retrieves details for all loyalty promotions. | None | Promotion Name |
|
GetPromotionDetail | Retrieves the details for a specific loyalty promotion. | Promotion Name | None |
|
Promotion Enrollment API (deprecated)
The following table describes the methods and parameters for the Promotion Enrollment API. Use the Promotion Enrollment API to enroll a member to a promotion.
Method Name | Purpose | Required Input Parameters | Optional Input Parameters | Output Parameters |
---|---|---|---|---|
PromotionEnrollments | Enrolls a member to a promotion. |
|
None |
|
Transaction API (deprecated)
The following table describes the methods and parameters for the Transaction API. Use the Transaction API to create transactions for a member, and process the transactions with the Oracle Loyalty Cloud engine.
Method Name | Purpose | Required Input Parameters | Optional Input Parameters | Output Parameters |
---|---|---|---|---|
CaptureAccrualTxn | Creates and processes an accrual transaction for a member into the specified loyalty program and returns the transaction processing status along with the generated transaction Id. |
|
|
|
ProcessAccrualTxn | Processes an accrual transaction and returns the transaction processing status. | Transaction Id | None |
|
ProcessRedeemTxn | Creates and processes a redemption transaction for a member into the specified loyalty program and then returns the transaction processing status along with the generated transaction Id. |
|
|
|
Voucher API (deprecated)
The following table describes the methods and parameters for the Voucher API. Use the Voucher API to obtain and use any available vouchers for a member.
Method Name | Purpose | Required Input Parameters | Optional Input Parameters | Output Parameters |
---|---|---|---|---|
AvailableVoucher | Checks for and returns the available vouchers for a specified member number. |
|
none |
|
AssignVoucher | Assigns a voucher from an external system such as a point-of-sale (POS) system, a Web site, or another external channel, to a loyalty program. |
|
|
|
VoucherValidityCheck | Checks the status of a specified voucher and returns its status in the response. | Voucher # | Activity Date If this parameter is not passed, the date defaults to the system date. |
|
VoucherStatusChange | Changes the status of a specified voucher from Available to Use, and returns a Pass or Fail status in the response. |
|
None |
|