Get all loyalty transactions
get
/crmRestApi/resources/11.13.18.05/loyTransactions
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the transaction with the specified transaction identifier.
Finder Variables:- LoyTransactionId; integer; The loyalty transaction identifier.
- TransactionNumberFinder: Finds the transaction with the specified transaction number.
Finder Variables:- TransactionNumber; string; The loyalty transaction number.
- PrimaryKey: Finds the transaction with the specified transaction identifier.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AccItmList; string; The attribute specifies the list of all accrual items for the given transaction. There is no default value, dependency, or limitation associated with this attribute.
- AccrualDisputeStatusCode; string; The attribute specifies the status of the created accrual dispute, that is, whether the accrual dispute created is approved or rejected. The accepted values are ORA_ACRL_DISPUTE_STAT_APPR and ORA_ACRL_DISPUTE_STAT_REJ. There is no default value, dependency, or limitation associated with this attribute.
- AccrualDisputeTypeCode; string; The attribute specifies the type of Accrual Dispute that is created. Accepted values are ORA_ACRL_DISPUTE_TYPE_INCOR and ORA_ACRL_DISPUTE_TYPE_MISSING. There is no default value, dependency, or limitation associated with this attribute.
- AccrualDisputedTransactionNumber; string; The attribute indicates transaction number of the accrual transaction which is incorrect when it got created. There is no default value, dependency or limitation associated with this attribute.
- ActivityDay; number; The transaction activity day. This attribute represents the day when an activity, either accrual or redemption, occurs. There is no default value, dependency, or limitation associated with this attribute.
- BookingClass; string; The booking class attribute specifies the class of the airline ticket. This is the list of value meaning for the booking class code. The accepted values are: Business or Economy. There is no default value, dependency, or limitation associated with this attribute.
- CancelledTransactionId; integer; The canceled transaction identifier. This attribute is the primary key of the transaction that is canceled. There is no default value, dependency, or limitation associated with this attribute.
- CancelledTransactionNumber; string; The attribiute indicates the cancelled transaction number associated with the transaction. There is no default value, dependency, or limitation associated with this attribute.
- ChildTransactionId; integer; The child transaction identifier. This attribute is the primary key of the transaction that is the child of the current transaction. There is no default value, dependency, or limitation associated with this attribute.
- ChildTransactionNumber; string; The attribute indicates the child transaction number associated with the transaction. There is no default value, dependency, or limitation associated with this attribute.
- Comments; string; The transaction comments. This attribute stores the comments entered by user, if any, for future reference. There is no default value, dependency, or limitation associated with this attribute.
- CorpRefMemberId; integer; The attribute represents the corporate reference member identifier in the case of the individual member performing a transaction on behalf of corporate. There is no default value, dependency, or limitation associated with this attribute.
- CorpRefName; string; The corporate reference member name. If the current member is part of the company or corporate account, then Oracle Loyalty Cloud populates this field. This is an optional attribute which is populated only when the transaction is done by an individual member on behalf of a company. There is no default value, dependency, or limitation associated with this attribute.
- CreatedBy; string; The details of who creates the transaction. Oracle Loyalty Cloud generates this attribute value during the creation of new transaction. There is no default value, dependency, or limitation associated with this attribute.
- CreationDate; string; The date when the transaction is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction. There is no default value, dependency, or limitation associated with this attribute.
- CurcyCode; string; The transaction currency code. This attribute indicates the currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value or dependency associated with this attribute.
- DestAirport; string; The list of value meaning for the destination airport code, representing the airport where the flight arrives when reaching its destination. The accepted values are: BOM, BOS, and SFO. There is no default value, dependency, or limitation associated with this attribute.
- DestAirportCode; string; The destination airport code. This attribute value is a code representing the airport where the flight arrives when reaching its destination. The accepted values are ORA_AIRPORT_BOM, ORA_AIRPORT_BOS, or ORA_AIRPORT_SFO. There is no default value, dependency, or limitation associated with this attribute.
- DestZone; string; The list of value meaning for destination airline zone code and is the zone where the flight arrives when it reaches its destination. The list of possible values are: Asia, Europe, North America, and so on. There is no default value, dependency, or limitation associated with this attribute.
- EventName; string; The attribute indicates the event name for which the transaction is created. There is no default value, dependency, or limitation associated with this attribute.
- ExternalProductLineMeaning; string; The attribute represents the list of value meaning for External Product Line Code. It represents the product line associated with the product for the transaction that is from an external source. The accepted value is Consumer Goods. There is no default value, dependency, or limitation associated with this attribute.
- ExternalProductName; string; The product name reference in the external system. There is no default value, dependency, or limitation associated with this attribute.
- ExternalProductTyeMeaning; string; The attribute represents the list of value meaning for External Product Type Code. The attribute value specifies the type of products coming into the Oracle Loyalty Cloud system from an external source. The accepted value is Electronics. There is no default value, dependency, or limitation associated with this attribute.
- FareBasisCode; string; The transaction fare basis. This attribute is a code which represents the fare basis on which the ticket fare is based. The accepted values are ORA_FARE_BASIS_BUSI or ORA_FARE_BASIS_ECO. There is no default value, dependency, or limitation associated with this attribute.
- FareBasisMeaning; string; The fare basis meaning attribute is the list of value meaning for the fare basis code. This attribute represents the fare basis on which the ticket fare is based. The accepted values are: Business or Economy. There is no default value, dependency, or limitation associated with this attribute.
- FareType; string; The fare type attribute is the list of value meaning for the fare type code. This attribute is a value that determines the class of the flight travel. The accepted values are: First Class, Economy, Business Class, and so on. There is no default value, dependency, or limitation associated with this attribute.
- IntegrationId; string; The attribute indicates the integration identifier associated with the transaction. There is no default value, dependency, or limitation associated with this attribute.
- LastUpdateDate; string; The date when the transaction is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are any changes to the transaction. There is no default value, dependency, or limitation associated with this attribute.
- LineItemNumber; integer; The line item number for a multiple line item order transaction. There is no default value, dependency, or limitation associated with this attribute.
- LoyAttrdefnBId; integer; The loyalty attribute definition identifier, which is the primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
- LoyTransactionId; integer; The primary key to identify a transaction. Oracle Loyalty Cloud generates this attribute value during the creation of a transaction record. There is no default value, dependency, or limitation associated with this attribute.
- MemberNumber; string; The member for whom the transaction is created. There is no default value, dependency, or limitation associated with this attribute.
- OrderNumber; string; The number associated with an order. This attribute is used by Oracle Loyalty Cloud when consolidating transactions. There is no default value, dependency, or limitation associated with this attribute.
- OrganizationCode; string; The organization code associated with the member transaction. There is no default value, dependency, or limitation associated with this attribute.
- OrigAirport; string; The attribute represents the list of value meaning for the origin airport code and represents the airport from where the flight departs. There is no default value, dependency, or limitation associated with this attribute.
- OrigZone; string; The attribute represents the list of value meaning for the origin airline zone code and represents the zone from where the flight departs. The possible values are: Asia, Europe, and so on. There is no default value, dependency, or limitation associated with this attribute.
- OwnerId; integer; The user that created the transaction and that owns the transaction. There is no default value, dependency, or limitation associated with this attribute.
- ParentTransactionId; integer; The transaction identifier for the parent transaction that creates the current transaction. There is no default value, dependency, or limitation associated with this attribute.
- ParentTransactionNumber; string; The attribute indicates the parent transaction number associated with the transaction. There is no default value, dependency, or limitation associated with this attribute.
- PartnerCompanyNumber; string; The attribute indicates the partner company number associated with the transaction. There is no default value, dependency, or limitation associated with this attribute.
- PaymentTypeMeaning; string; The attribute represents the list of value meaning for the payment type code. The attribute value specifies how the payment is made for the transaction. There is no default value, dependency, or limitation associated with this attribute.
- PnrNumber; string; The transaction passenger name record (PNR) number. There is no default value, dependency, or limitation associated with this attribute.
- PointTypeName; string; The point type name. This attribute is dependent on the program name identifier. There is no default value, dependency, or limitation associated with this attribute.
- Points; number; The transaction points. This attribute corresponds to the price of the transaction in points. There is no default value, dependency, or limitation associated with this attribute.
- PrConId; integer; The attribute indicates the Primary contact identifier of the member for whom the transaction was created. There is no default value, dependency, or limitation associated with this attribute.
- ProcessDt; string; The transaction process date. This attribute specifies the day on which the created transaction is processed. There is no default value, dependency, or limitation associated with this attribute.
- ProdId; integer; The attribute indicates the product identifier associated with the transaction. There is no default value, dependency, or limitation associated with this attribute.
- ProgramName; string; The transaction program name. This attribute indicates the program for which the transaction is created. There is no default value, dependency, or limitation associated with this attribute.
- ProgramNumber; string; The program number associated with the transaction. There is no default value, dependency, or limitation associated with this attribute.
- QualifyingPointUsed; string; The qualifying point used. These points count toward a member???s tier status. There is no default value, dependency, or limitation associated with this attribute.
- ReferredByMemNumber; string; The attribute indicates the referred by member number associated with the transaction. There is no default value, dependency, or limitation associated with this attribute.
- SmActionType; string; The attribute represents the list of value meaning for the social action type code and the value provides the social media action type. The accepted values are Tweet, Rate, Share, and so on. There is no default value, dependency, or limitation associated with this attribute.
- SmActionTypeCode; string; The code that provides the social media action type. The accepted values are ORA_SOCIAL_ACTION_CHECK_IN, ORA_SOCIAL_ACTION_RATE, or ORA_SOCIAL_ACTION_SHARE. There is no default value, dependency, or limitation associated with this attribute.
- Source; string; The attribute represents the list of value meaning for the transaction source code and indicates the transaction activity type, such as Airlines, Hotels, Car Rental, and so on. There is no default value, dependency, or limitation associated with this attribute.
- SourceCode; string; The code that represents the source of the transaction. The possible values are ORA_TXN_SOURCE_WEB, ORA_TXN_SOURCE_MOBILE, ORA_TXN_SOURCE_BILL. There is no default value, dependency, or limitation associated with this attribute.
- StatusCode; string; The current state of the transaction. The accepted values are ORA_TXN_STAT_IN_PROG, ORA_TXN_STAT_REJ, or ORA_TXN_STAT_PROCESSED. There is no default value, dependency, or limitation associated with this attribute.
- StatusMeaning; string; The transaction status meaning. There is no default value, dependency, or limitation associated with this attribute.
- SubStatus; string; The attribute represents the list of value meaning for the sub status code, and specifies the status of the transaction processing, for example, whether there is an error or the transaction is successful, and so on. The accepted values are Error, Success, and so on. There is no default value, dependency, or limitation associated with this attribute.
- SubStatusCode; string; The code that specifies the status of the transaction processing, for example, whether there is an error or the transaction is successful, and so on. The accepted values are ORA_TXN_SUB_STAT_ERROR, ORA_TXN_SUB_STAT_SUCCESS, or ORA_TXN_SUB_STAT_NO_PROMO_QF. There is no default value, dependency, or limitation associated with this attribute.
- SubTypeCode; string; The transaction subtype name. This attribute is dependent on the TypeCodeName attribute. The accepted values are, A. if Accrual??? ORA_ACC_MCR, ORA_ACC_PROD or B. if Redemption ??? ORA_RED_PROD, ORA_RED_MDT. There is no default value or limitation associated with this attribute.
- SubTypeMeaning; string; The transaction sub type meaning. There is no default value, dependency, or limitation associated with this attribute.
- TotalDays; integer; The total days that are required for travel between the source and destination locations. There is no default value, dependency, or limitation associated with this attribute.
- TransactionChannel; string; The attribute represents the list of value meaning for transaction channel code, and indicates how the transaction is created. The accepted values are: Mobile, Web, or Phone. There is no default value, dependency, or limitation associated with this attribute.
- TransactionDate; string; The date when the transaction is completed. There is no default value, dependency, or limitation associated with this attribute.
- TransactionNumber; string; The transaction number. This is an alternate key that is mandatory during an update. This attribute is automatically generated by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.
- TransferMemNumber; string; The member number to whom the points were transferred. There is no default value, dependency, or limitation associated with this attribute.
- TransferPoints; number; The attribute indicates the number of points that would be transferred in the case of a TransferPoints redemption transaction. There is no default value, dependency, or limitation associated with this attribute.
- TrvClass; string; The attribute represents the list of value meaning for travel class code, and indicates the class in which the passenger is traveling. The accepted values are: Business, Economy, and so on. There is no default value, dependency, or limitation associated with this attribute.
- TypeCode; string; The transaction type code name. The accepted values are ORA_TXN_ACC, ORA_TXN_RED and so on. There is no default value, dependency, or limitation associated with this attribute.
- TypeMeaning; string; The transaction type meaning. There is no default value, dependency, or limitation associated with this attribute.
- VoucherNumber; string; The voucher number attribute is used to uniquely identify a voucher. There is no default value, dependency, or limitation associated with this attribute.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : loyTransactions
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : loyTransactions-item-response
Type:
Show Source
object-
AccItmList: string
Title:
Accrual Item ListRead Only:trueMaximum Length:255The attribute specifies the list of all accrual items for the given transaction. There is no default value, dependency, or limitation associated with this attribute. -
AccrualDisputedTransactionNumber: string
Title:
Disputed TransactionThe attribute indicates transaction number of the accrual transaction which is incorrect when it got created. There is no default value, dependency or limitation associated with this attribute. -
AccrualDisputeStatus: string
Title:
Accrual Dispute Status MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for Accrual Dispute Status. The attribute specifies the status of the created accrual dispute, that is, whether the accrual dispute created is approved or rejected. There is no default value, dependency, or limitation associated with this attribute. -
AccrualDisputeStatusCode: string
Title:
Accrual Dispute StatusMaximum Length:30The attribute specifies the status of the created accrual dispute, that is, whether the accrual dispute created is approved or rejected. The accepted values are ORA_ACRL_DISPUTE_STAT_APPR and ORA_ACRL_DISPUTE_STAT_REJ. There is no default value, dependency, or limitation associated with this attribute. -
AccrualDisputeType: string
Title:
Accrual Dispute Type MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for Accrual Dispute Type. The attribute specifies the type of accrual dispute that is created. The accepted values are: Missing or Incorrect. There is no default value, dependency, or limitation associated with this attribute. -
AccrualDisputeTypeCode: string
Title:
Accrual Dispute TypeMaximum Length:30The attribute specifies the type of Accrual Dispute that is created. Accepted values are ORA_ACRL_DISPUTE_TYPE_INCOR and ORA_ACRL_DISPUTE_TYPE_MISSING. There is no default value, dependency, or limitation associated with this attribute. -
AccrualItems: array
Accrual Items
Title:
Accrual ItemsThe accrual items resource is used to retrieve the accrual items that have been updated on transaction processing. -
ActivityDate: string
(date-time)
Title:
Activity DateThe date when a transaction activity occurs. The transaction can be an accrual or redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
ActivityDay: number
Title:
Activity DayThe transaction activity day. This attribute represents the day when an activity, either accrual or redemption, occurs. There is no default value, dependency, or limitation associated with this attribute. -
ActivityHour: number
Title:
Activity HourThe transaction activity hour. This attribute represents the time in hours when an activity, either accrual or redemption, occurs. There is no default value, dependency, or limitation associated with this attribute. -
AdjustedListPrice: number
Title:
Adjusted List PriceThe currency component that might be adjusted against a member's point balance. There is no default value, dependency, or limitation associated with this attribute. -
AmountValue: number
Title:
AmountThe total amount spent on the accrual or redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
ApproveDt: string
(date-time)
Title:
Approve DateThe transaction approval date. If the transactions involve an approval process, then the identifier indicates the date when the transaction is approved by the reviewer. There is no default value, dependency, or limitation associated with this attribute. -
BackupInvOrgId: integer
The organization from where inventory is being picked for the backup product. For example, when a transaction is created, sometimes the inventory or goods are picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is picked from a different organization. There is no default value, dependency, or limitation associated with this attribute.
-
BackupProductNumber: string
The backup product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute.
-
BookClassCode: string
Title:
Booking ClassMaximum Length:30The booking class code. This attribute specifies the class of the airline ticket. The accepted values are ORA_TRAVL_BOOK_BUSI or ORA_TRAVL_BOOK_ECO. There is no default value, dependency, or limitation associated with this attribute. -
BookingClass: string
Title:
Booking Class MeaningRead Only:trueMaximum Length:80The booking class attribute specifies the class of the airline ticket. This is the list of value meaning for the booking class code. The accepted values are: Business or Economy. There is no default value, dependency, or limitation associated with this attribute. -
BookingDt: string
(date-time)
Title:
Booking DateThe transaction booking date. If the transaction is an airline transaction, then this attribute indicates the date when the booking is made for travel. There is no default value, dependency, or limitation associated with this attribute. -
CancelledTransactionId: integer
(int64)
Title:
Canceled TransactionThe canceled transaction identifier. This attribute is the primary key of the transaction that is canceled. There is no default value, dependency, or limitation associated with this attribute. -
CancelledTransactionNumber: string
Title:
Canceled Transaction NumberMaximum Length:30The attribiute indicates the cancelled transaction number associated with the transaction. There is no default value, dependency, or limitation associated with this attribute. -
CancReasonCode: string
Title:
Cancellation Reason CodeMaximum Length:30The cancellation reason code. This attribute value represents the reason why the transaction is canceled. There is no default value, dependency, or limitation associated with this attribute. -
ChildTransactionId: integer
(int64)
Title:
Child Transaction IDThe child transaction identifier. This attribute is the primary key of the transaction that is the child of the current transaction. There is no default value, dependency, or limitation associated with this attribute. -
ChildTransactionNumber: string
Title:
Child Transaction NumberMaximum Length:30The attribute indicates the child transaction number associated with the transaction. There is no default value, dependency, or limitation associated with this attribute. -
Comments: string
Title:
CommentsMaximum Length:250The transaction comments. This attribute stores the comments entered by user, if any, for future reference. There is no default value, dependency, or limitation associated with this attribute. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The currency code used by the corporation. There is no default value, dependency, or limitation associated with this attribute. -
CorporateReferenceNumber: string
Title:
Company Reference NumberMaximum Length:30The reference to a third-party corporate member from the program to get the points split for the individual and the corporation or company, if an individual member completes a transaction on behalf of the corporation or company. There is no default value, dependency, or limitation associated with this attribute. -
CorpRefMemberId: integer
(int64)
Title:
Loyalty Member IDThe attribute represents the corporate reference member identifier in the case of the individual member performing a transaction on behalf of corporate. There is no default value, dependency, or limitation associated with this attribute. -
CorpRefName: string
Title:
Company ReferenceMaximum Length:100The corporate reference member name. If the current member is part of the company or corporate account, then Oracle Loyalty Cloud populates this field. This is an optional attribute which is populated only when the transaction is done by an individual member on behalf of a company. There is no default value, dependency, or limitation associated with this attribute. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The details of who creates the transaction. Oracle Loyalty Cloud generates this attribute value during the creation of new transaction. There is no default value, dependency, or limitation associated with this attribute. -
CreateInProgressStatusTxnFlag: boolean
Title:
Create a Transaction with In-Progress StatusDefault Value:falseThe flag indicates whether the transaction will be created and set to the In Progress status. This is an optional field for the REST API. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the transaction is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction. There is no default value, dependency, or limitation associated with this attribute. -
CurcyCode: string
Title:
Currency CodeMaximum Length:20The transaction currency code. This attribute indicates the currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value or dependency associated with this attribute. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate method that is applied for the transaction. There is no default value, dependency, or limitation associated with this attribute. -
CurcyExchDt: string
(date-time)
Title:
Currency Exchange DateThe date when the currency exchange occurs during the transaction creation. There is no default value, dependency, or limitation associated with this attribute. -
Description: string
Title:
ProductThe attribute indicates the description of the product that would be accrued or redeemed in the transaction. There is no default value, dependency, or limitation associated with this attribute. -
DestAirport: string
Title:
Destination Airport MeaningRead Only:trueMaximum Length:80The list of value meaning for the destination airport code, representing the airport where the flight arrives when reaching its destination. The accepted values are: BOM, BOS, and SFO. There is no default value, dependency, or limitation associated with this attribute. -
DestAirportCode: string
Title:
Destination AirportMaximum Length:30The destination airport code. This attribute value is a code representing the airport where the flight arrives when reaching its destination. The accepted values are ORA_AIRPORT_BOM, ORA_AIRPORT_BOS, or ORA_AIRPORT_SFO. There is no default value, dependency, or limitation associated with this attribute. -
DestCityCode: string
Title:
Destination CityMaximum Length:30The destination city code. This attribute value represents the city where the flight arrives when it reaches its destination. There is no default value, dependency, or limitation associated with this attribute. -
DestZone: string
Title:
Destination Air Line Zone MeaningRead Only:trueMaximum Length:80The list of value meaning for destination airline zone code and is the zone where the flight arrives when it reaches its destination. The list of possible values are: Asia, Europe, North America, and so on. There is no default value, dependency, or limitation associated with this attribute. -
DestZoneCode: string
Title:
Destination ZoneMaximum Length:30The zone where the flight arrives when it reaches its destination. The list of possible values are ORA_AIRLINE_ZONE_ASIA, ORA_AIRLINE_ZONE_EUROPE, or ORA_AIRLINE_ZONE_NAMER. There is no default value, dependency, or limitation associated with this attribute. -
DocumentNumber: string
Title:
Document NumberMaximum Length:30The document number associated with the transaction. This attribute provides additional information in the transaction for the retail industry. There is no default value, dependency, or limitation associated with this attribute. -
EndDt: string
(date-time)
Title:
End DateThe transaction end date. This attribute is the date when the transaction is no longer in effect. This attribute value, if provided, must be set to a value after the StartDt attribute. There is no default value or dependency associated with this attribute. -
EventName: string
Title:
Event NameMaximum Length:75The attribute indicates the event name for which the transaction is created. There is no default value, dependency, or limitation associated with this attribute. -
ExpireInDays: number
Title:
Expires in DaysThe date when the accrued points will expire, in days. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductLine: string
Title:
Product Line - ExternalMaximum Length:30The product line associated with the product for the transaction that is from an external source. The accepted value is ORA_EXT_PROD_LINE_CG. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductLineMeaning: string
Title:
External Product Line MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for External Product Line Code. It represents the product line associated with the product for the transaction that is from an external source. The accepted value is Consumer Goods. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductName: string
Title:
Product Name - ExternalMaximum Length:240The product name reference in the external system. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductTyeMeaning: string
Title:
External Product Type MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for External Product Type Code. The attribute value specifies the type of products coming into the Oracle Loyalty Cloud system from an external source. The accepted value is Electronics. There is no default value, dependency, or limitation associated with this attribute. -
ExternalProductType: string
Title:
Product Type - ExternalMaximum Length:30The type of products coming into the Oracle Loyalty Cloud system from an external source. The accepted value is ORA_EXT_PROD_TYPE_ELEC. There is no default value, dependency, or limitation associated with this attribute. -
ExternalReservationNumber: string
Title:
External Reservation NumberMaximum Length:250The external reservation number is specific to the airline industry where a reservation is performed by an agent and has different reservation numbers. There is no default value, dependency, or limitation associated with this attribute. -
ExternalTransaction: string
Title:
ExternalMaximum Length:1Default Value:NThe details of the transaction coming from a partner???s external application into Oracle Loyalty Cloud when Oracle Loyalty Cloud is integrated with a third-party application. There is no default value, dependency, or limitation associated with this attribute. -
FareBasis: string
Title:
Fare BasisMaximum Length:30The transaction fare basis. This attribute is a code which represents the fare basis on which the ticket fare is based. The accepted values are ORA_FARE_BASIS_BUSI or ORA_FARE_BASIS_ECO. There is no default value, dependency, or limitation associated with this attribute. -
FareBasisCode: string
Title:
Fare Basis CodeMaximum Length:30The transaction fare basis. This attribute is a code which represents the fare basis on which the ticket fare is based. The accepted values are ORA_FARE_BASIS_BUSI or ORA_FARE_BASIS_ECO. There is no default value, dependency, or limitation associated with this attribute. -
FareBasisMeaning: string
Title:
Fare Basis MeaningRead Only:trueMaximum Length:80The fare basis meaning attribute is the list of value meaning for the fare basis code. This attribute represents the fare basis on which the ticket fare is based. The accepted values are: Business or Economy. There is no default value, dependency, or limitation associated with this attribute. -
FareType: string
Title:
Fare Type MeaningRead Only:trueMaximum Length:80The fare type attribute is the list of value meaning for the fare type code. This attribute is a value that determines the class of the flight travel. The accepted values are: First Class, Economy, Business Class, and so on. There is no default value, dependency, or limitation associated with this attribute. -
FareTypeCode: string
Title:
Fare TypeMaximum Length:30The fare type code. This attribute is a code value that determines the class of the flight travel. The accepted values are ORA_FARE_BUSN_CLASS or ORA_FARE_FIRST_CLASS. There is no default value, dependency, or limitation associated with this attribute. -
FlightNumber: string
Title:
Flight NumberMaximum Length:30The transaction flight number. If the transaction pertains to airlines, then this attribute indicates the flight number of the flight where the travel takes place. This attribute is entered by the user during transaction creation. There is no default value, dependency, or limitation associated with this attribute. -
FltTypeCode: string
Title:
Flight Type CodeMaximum Length:30The attribute specifies the flight type, for example, Boeing or Airbus. There is no default value, dependency, or limitation associated with this attribute. -
GdsRecLocator: string
Title:
GDS Record LocatorMaximum Length:30The global distribution system (GDS) record locator. There is no default value, dependency, or limitation associated with this attribute. -
IncentivChoice: string
Title:
Incentive ChoiceMaximum Length:30The incentives or rewards that a member receives for enrolling into a promotion. There is no default value, dependency, or limitation associated with this attribute. -
IntegrationId: string
Title:
Integration IDMaximum Length:30The attribute indicates the integration identifier associated with the transaction. There is no default value, dependency, or limitation associated with this attribute. -
InternalDest: string
Title:
Internal DestinationMaximum Length:15The details of the destination that is used internally by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
InternalFlightDt: string
(date-time)
Title:
Internal Flight DateThe local date for the flight for the country. For example, 24/01/2018 is equal to GMT +5.30 in India. There is no default value, dependency, or limitation associated with this attribute. -
InternalOrigin: string
Title:
Internal OriginMaximum Length:15The flight origin details that are local to the region. There is no default value, dependency, or limitation associated with this attribute. -
InvOrgId: integer
(int64)
Title:
Inventory Organization IDThe organization from where inventory is being picked. For example, when a transaction is created, sometimes the inventory or goods are picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is being picked from a different organization. There is no default value, dependency, or limitation associated with this attribute. -
ItemNumber: string
Title:
Item NumberMaximum Length:30The transaction item number that is used during transaction creation. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the transaction is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are any changes to the transaction. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the transaction. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the transaction take place. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login details of the user who last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the transaction take place. There is no default value, dependency, or limitation associated with this attribute. -
LineItemNumber: integer
(int64)
Title:
Line Item NumberThe line item number for a multiple line item order transaction. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoanBalance: number
Title:
Loan BalanceThe remaining balance of the loan that you can use during transaction creation. There is no default value, dependency, or limitation associated with this attribute. -
LoanRepaymentDt: string
(date-time)
Title:
Loan Repayment DateThe date which specifies when the loan is repaid. There is no default value, dependency, or limitation associated with this attribute. -
LocationName: string
Title:
Location NameMaximum Length:30The attribute is text that used in the retail industry for giving promotions. For example, for the same retailer, the promotion could be applied only if the store is located in India. If the store is located outside India no promotions are applied. There is no default value, dependency, or limitation associated with this attribute. -
LoyAttrdefnBId: integer
(int64)
Title:
Attribute Definition IDRead Only:trueThe loyalty attribute definition identifier, which is the primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute. -
LoyTransactionId: integer
(int64)
Title:
Transaction IDThe primary key to identify a transaction. Oracle Loyalty Cloud generates this attribute value during the creation of a transaction record. There is no default value, dependency, or limitation associated with this attribute. -
MarketingFlightNumber: string
Title:
Marketing Flight NumberMaximum Length:30The marketing flight number, which is specific to the airline industry and which indicates the flight number used in the airline's marketing campaign. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member NumberRead Only:trueMaximum Length:30The member for whom the transaction is created. There is no default value, dependency, or limitation associated with this attribute. -
OperFltNum: string
Title:
Operating Flight NumberMaximum Length:30The attribute specifies the operating flight number in case of the airline loyalty transaction. There is no default value, dependency, or limitation associated with this attribute. -
OptyCost: number
Title:
Opportunity CostThe transaction opportunity cost associated with the transaction. There is no default value, dependency, or limitation associated with this attribute. -
OrderNumber: string
Title:
Order NumberMaximum Length:30The number associated with an order. This attribute is used by Oracle Loyalty Cloud when consolidating transactions. There is no default value, dependency, or limitation associated with this attribute. -
OrderQuantity: number
Title:
Order QuantityThe attribute order quantity specifies the quantity of items that would be purchased in the order. This is specifically used in the retail industry. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationCode: string
Title:
OrganizationMaximum Length:18The organization code associated with the member transaction. There is no default value, dependency, or limitation associated with this attribute. -
OrigAirport: string
Title:
Origination Airport MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for the origin airport code and represents the airport from where the flight departs. There is no default value, dependency, or limitation associated with this attribute. -
OrigAirportCode: string
Title:
Origin AirportMaximum Length:30The origin airport code. This attribute value represents the airport from where the flight departs. There is no default value, dependency, or limitation associated with this attribute. -
OrigAmount: number
Title:
Original AmountThe attribute specifies the original amount incurred during the transaction without taxes. There is no default value, dependency, or limitation associated with this attribute. -
OriginCityCode: string
Title:
Origin City CodeMaximum Length:30The origin city code. This attribute value represents the city from where the flight departs. There is no default value, dependency, or limitation associated with this attribute. -
OrigOrderId: integer
(int64)
Title:
Original Order IDThe attribute indicates the original order identifier that lead to the creation of these transactions. There is no default value, dependency, or limitation associated with this attribute. -
OrigOrdItmId: integer
(int64)
Title:
Original Order Line ItemThe details of the order item that is originally placed, especially used for exchanges, and so on, in retail transactions. There is no default value, dependency, or limitation associated with this attribute. -
OrigPoints: number
Title:
Original PointThe original value of the transaction in points without any subsequent bonus added by each promotion. There is no default value, dependency, or limitation associated with this attribute. -
OrigZone: string
Title:
Origination Air Line Zone MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for the origin airline zone code and represents the zone from where the flight departs. The possible values are: Asia, Europe, and so on. There is no default value, dependency, or limitation associated with this attribute. -
OrigZoneCode: string
Title:
Origin ZoneMaximum Length:30The code representing the zone from where the flight departs. Possible values are ORA_AIRLINE_ZONE_ASIA, ORA_AIRLINE_ZONE_EUROPE, or ORA_AIRLINE_ZONE_NAMER. There is no default value, dependency, or limitation associated with this attribute. -
OvrDupCheck: string
Title:
Duplicate Check OverriddenMaximum Length:1Default Value:NThe flag that indicates whether duplicate line items are allowed in a transaction or not. There is no default value, dependency, or limitation associated with this attribute. -
OwnerId: integer
(int64)
Title:
Owner IDThe user that created the transaction and that owns the transaction. There is no default value, dependency, or limitation associated with this attribute. -
PackageCode: string
Title:
Package CodeMaximum Length:30The transaction package code. This attribute identifies the package from which line items are picked. There is no default value, dependency, or limitation associated with this attribute. -
ParentTransactionId: integer
(int64)
Title:
Partner Transaction IDThe transaction identifier for the parent transaction that creates the current transaction. There is no default value, dependency, or limitation associated with this attribute. -
ParentTransactionNumber: string
Title:
Parent Transaction NumberMaximum Length:30The attribute indicates the parent transaction number associated with the transaction. There is no default value, dependency, or limitation associated with this attribute. -
PartitionName: string
Title:
Partition NameMaximum Length:30The transaction partition name. There is no default value, dependency, or limitation associated with this attribute. -
PartnerCompanyNumber: string
Title:
Partner NumberRead Only:trueMaximum Length:30The attribute indicates the partner company number associated with the transaction. There is no default value, dependency, or limitation associated with this attribute. -
PartnerNumber: string
Title:
Partner NumberThe partner number attribute is a unique identifier from HZ_PARTIES which gives partner details against whom the transaction is being created. There is no default value, dependency, or limitation associated with this attribute. -
PaymentTypeMeaning: string
Title:
Payment Type MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for the payment type code. The attribute value specifies how the payment is made for the transaction. There is no default value, dependency, or limitation associated with this attribute. -
PeriodDurCode: string
Title:
Period DurationMaximum Length:30The period duration code which specifies the duration in days, or months, and so on. There is no default value, dependency, or limitation associated with this attribute. -
PeriodTypeCode: string
Title:
Period TypeMaximum Length:30The period type code. Period type options are Months, Years, Lifetime, and so on. There is no default value, dependency, or limitation associated with this attribute. -
PnrName: string
Title:
PNR NameMaximum Length:50The transaction passenger name record (PNR) name. There is no default value, dependency, or limitation associated with this attribute. -
PnrNumber: string
Title:
PNR NumberMaximum Length:50The transaction passenger name record (PNR) number. There is no default value, dependency, or limitation associated with this attribute. -
Points: number
Title:
Base PointsThe transaction points. This attribute corresponds to the price of the transaction in points. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeName: string
Title:
Point Type NameThe point type name. This attribute is dependent on the program name identifier. There is no default value, dependency, or limitation associated with this attribute. -
PostDt: string
(date-time)
Title:
Post DateThe date when the transaction is posted. There is no default value, dependency, or limitation associated with this attribute. -
PrConId: integer
(int64)
Title:
Primary Contact IDRead Only:trueThe attribute indicates the Primary contact identifier of the member for whom the transaction was created. There is no default value, dependency, or limitation associated with this attribute. -
PriceOverriden: string
Title:
Price OverriddenMaximum Length:1Default Value:NThe flag that indicates whether the price needs to be overridden or not. There is no default value, dependency, or limitation associated with this attribute. -
ProcessDt: string
(date-time)
Title:
Processed DateThe transaction process date. This attribute specifies the day on which the created transaction is processed. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingComment: string
Title:
Processing InformationMaximum Length:1000The transaction processing comment that provides the details of an error during transaction processing, if any occurred. There is no default value, dependency, or limitation associated with this attribute. -
ProcessingLog: string
Title:
Processing LogMaximum Length:1000The transaction processing log that provides details of all the promotions that are applied, all the points that are assigned, and all the vouchers that are assigned, if any. There is no default value, dependency, or limitation associated with this attribute. -
ProdId: integer
(int64)
Title:
Product IDThe attribute indicates the product identifier associated with the transaction. There is no default value, dependency, or limitation associated with this attribute. -
ProductNumber: string
Title:
Product NumberThe product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute. -
ProgramName: string
Title:
Program NameThe transaction program name. This attribute indicates the program for which the transaction is created. There is no default value, dependency, or limitation associated with this attribute. -
ProgramNumber: string
Title:
Program NumberMaximum Length:30The program number associated with the transaction. There is no default value, dependency, or limitation associated with this attribute. -
Promotions: array
Promotions
Title:
PromotionsThe loyalty promotions resource is used to retrieve the details of a loyalty promotion that are applied to the transaction. -
PtnrProcDt: string
(date-time)
Title:
Partner Processing DateThe date on which the transaction is processed at the partner end. There is no default value, dependency, or limitation associated with this attribute. -
PtnrStatusCode: string
Title:
Partner Status CodeMaximum Length:30The status code used by the partner when processing the transaction. There is no default value, dependency, or limitation associated with this attribute. -
PymtTypeCode: string
Title:
Payment TypeMaximum Length:30The payment type code specifies how the payment is made for the transaction. There is no default value, dependency, or limitation associated with this attribute. -
QualifyingPointUsed: string
Title:
QualifyingMaximum Length:1Default Value:NThe qualifying point used. These points count toward a member???s tier status. There is no default value, dependency, or limitation associated with this attribute. -
QueuedProcessingFlag: boolean
Title:
Queued ProcessingMaximum Length:1Default Value:falseThe flag indicates whether created transactions would be processed in real time or in batch mode. -
ReasonCode: string
Title:
Reason CodeMaximum Length:30The reason for the cancellation or refund, if the transaction is cancelled. For example, a fee that is inadvertently applied. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionItems: array
Redemption Items
Title:
Redemption ItemsThe redemption items resource is used to retrieve the redemption items that have been updated on transaction processing. -
RedemptionQuantity: number
Title:
Redemption QuantityThe attribute redemption quantity specifies the quantity to be redeemed. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionQuantityUOMCode: string
Title:
Unit of Measure for the Redemption QuantityMaximum Length:30The redemption products quantity unit of measure (UOM) code. For example, possible UOM codes are kilograms or litres. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByMemNumber: string
Title:
Referred-by Member NumberRead Only:trueMaximum Length:30The attribute indicates the referred by member number associated with the transaction. There is no default value, dependency, or limitation associated with this attribute. -
RefundPct: number
Title:
Refund PercentageThe percentage of the refund that is granted in the transaction. There is no default value, dependency, or limitation associated with this attribute. -
RfndOvrdCmnts: string
Title:
Refund Override CommentsMaximum Length:250The refund override comments in the event a refund is made. There is no default value, dependency, or limitation associated with this attribute. -
RfndOvrdRsnCode: string
Title:
Refund Override ReasonMaximum Length:30The refund override reason code in the event a refund is made. There is no default value, dependency, or limitation associated with this attribute. -
SmActionType: string
Title:
Social Action Type MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for the social action type code and the value provides the social media action type. The accepted values are Tweet, Rate, Share, and so on. There is no default value, dependency, or limitation associated with this attribute. -
SmActionTypeCode: string
Title:
Social Action TypeMaximum Length:30The code that provides the social media action type. The accepted values are ORA_SOCIAL_ACTION_CHECK_IN, ORA_SOCIAL_ACTION_RATE, or ORA_SOCIAL_ACTION_SHARE. There is no default value, dependency, or limitation associated with this attribute. -
Source: string
Title:
Transaction Source MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for the transaction source code and indicates the transaction activity type, such as Airlines, Hotels, Car Rental, and so on. There is no default value, dependency, or limitation associated with this attribute. -
SourceCode: string
Title:
SourceMaximum Length:30The code that represents the source of the transaction. The possible values are ORA_TXN_SOURCE_WEB, ORA_TXN_SOURCE_MOBILE, ORA_TXN_SOURCE_BILL. There is no default value, dependency, or limitation associated with this attribute. -
StartDt: string
(date-time)
Title:
Start DateThe transaction start date. Either Oracle Loyalty Cloud generates this attribute value when a new transaction is created and populates the attribute with the current date, or it is provided as input from the user when creating transaction using the resource. There is no default value, dependency, or limitation associated with this attribute. -
StatusCode: string
Title:
StatusMaximum Length:30Default Value:ORA_TXN_STAT_IN_PROGThe current state of the transaction. The accepted values are ORA_TXN_STAT_IN_PROG, ORA_TXN_STAT_REJ, or ORA_TXN_STAT_PROCESSED. There is no default value, dependency, or limitation associated with this attribute. -
StatusMeaning: string
Title:
Status MeaningRead Only:trueMaximum Length:80The transaction status meaning. There is no default value, dependency, or limitation associated with this attribute. -
SubmitDt: string
(date-time)
Title:
Submit DateThe transaction submission date. Oracle Loyalty Cloud assigns this attribute value when the transaction is submitted for approval by changing the Transaction Status attribute value to Submitted. There is no default value, dependency, or limitation associated with this attribute. -
SubStatus: string
Title:
Sub Status MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for the sub status code, and specifies the status of the transaction processing, for example, whether there is an error or the transaction is successful, and so on. The accepted values are Error, Success, and so on. There is no default value, dependency, or limitation associated with this attribute. -
SubStatusCode: string
Title:
Processing Sub StatusMaximum Length:30The code that specifies the status of the transaction processing, for example, whether there is an error or the transaction is successful, and so on. The accepted values are ORA_TXN_SUB_STAT_ERROR, ORA_TXN_SUB_STAT_SUCCESS, or ORA_TXN_SUB_STAT_NO_PROMO_QF. There is no default value, dependency, or limitation associated with this attribute. -
SubTypeCode: string
Title:
Transaction Sub TypeMaximum Length:30The transaction subtype name. This attribute is dependent on the TypeCodeName attribute. The accepted values are, A. if Accrual??? ORA_ACC_MCR, ORA_ACC_PROD or B. if Redemption ??? ORA_RED_PROD, ORA_RED_MDT. There is no default value or limitation associated with this attribute. -
SubTypeMeaning: string
Title:
SubtypeRead Only:trueMaximum Length:80The transaction sub type meaning. There is no default value, dependency, or limitation associated with this attribute. -
TaxAmount: number
Title:
Tax AmountThe attribute tax amount specifies the total amount that would incur as tax for the transaction. There is no default value, dependency, or limitation associated with this attribute. -
TicketNumber: string
Title:
Ticket NumberMaximum Length:30The unique number that is used to identify the ticket booking for an airline transaction. There is no default value, dependency, or limitation associated with this attribute. -
ToMemberNumber: string
Title:
To MemberMaximum Length:30The unique identification number of the member to whom points are transferred. There is no default value, dependency, or limitation associated with this attribute. -
TotalDays: integer
(int64)
Title:
DaysThe total days that are required for travel between the source and destination locations. There is no default value, dependency, or limitation associated with this attribute. -
TotalLines: number
Title:
Total LinesThe total line items for the transaction. A transaction can include many order line items. There is no default value, dependency, or limitation associated with this attribute. -
TransactionChannel: string
Title:
Transaction Channel MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for transaction channel code, and indicates how the transaction is created. The accepted values are: Mobile, Web, or Phone. There is no default value, dependency, or limitation associated with this attribute. -
TransactionChannelCode: string
Title:
ChannelMaximum Length:30The code that indicates how the transaction is created. The accepted values are ORA_TXN_CHANNEL_MOBILE, ORA_TXN_CHANNEL_WEB, or ORA_TXN_CHANNEL_TELE. There is no default value, dependency, or limitation associated with this attribute. -
TransactionDate: string
(date-time)
Title:
Transaction DateThe date when the transaction is completed. There is no default value, dependency, or limitation associated with this attribute. -
TransactionNumber: string
Title:
Transaction NumberMaximum Length:30The transaction number. This is an alternate key that is mandatory during an update. This attribute is automatically generated by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
TransactionSourceCode: string
Title:
Transaction Source CodeMaximum Length:30The transaction source code attribute indicates the transaction activity type, such as Airlines, Hotels, Car Rental, and so on. There is no default value, dependency, or limitation associated with this attribute. -
TransferMemNumber: string
Title:
Transfer to MemberMaximum Length:30The member number to whom the points were transferred. There is no default value, dependency, or limitation associated with this attribute. -
TransferPoints: number
Title:
Transfer PointsThe attribute indicates the number of points that would be transferred in the case of a TransferPoints redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
TrvClass: string
Title:
Travel Class MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for travel class code, and indicates the class in which the passenger is traveling. The accepted values are: Business, Economy, and so on. There is no default value, dependency, or limitation associated with this attribute. -
TrvClassCode: string
Title:
Travel ClassMaximum Length:30The code that indicates the class in which the passenger is traveling. The accepted values are ORA_TRAVL_CLASS_BUSI, ORA_TRAVL_CLASS_ECO. There is no default value, dependency, or limitation associated with this attribute. -
TrvlDistance: number
Title:
DistanceThe transaction travel distance. This attribute stores the total miles travelled. There is no default value, dependency, or limitation associated with this attribute. -
TypeCode: string
Title:
Transaction TypeMaximum Length:30The transaction type code name. The accepted values are ORA_TXN_ACC, ORA_TXN_RED and so on. There is no default value, dependency, or limitation associated with this attribute. -
TypeMeaning: string
Title:
Type MeaningRead Only:trueMaximum Length:80The transaction type meaning. There is no default value, dependency, or limitation associated with this attribute. -
UnaccMinor: string
Title:
Unaccounted MinorMaximum Length:1Default Value:NThe unaccounted transaction for a minor, that is below the age of majority. There is no default value, dependency, or limitation associated with this attribute. -
ValStatusCode: string
Title:
Value Status CodeMaximum Length:30The status of the validation performed on the record. There is no default value, dependency, or limitation associated with this attribute. -
VoucherNumber: string
Title:
Voucher NumberThe voucher number attribute is used to uniquely identify a voucher. There is no default value, dependency, or limitation associated with this attribute. -
VoucherQuantity: number
Title:
Voucher QuantityThe attribute specifies the number of vouchers that are available. There is no default value, dependency, or limitation associated with this attribute. -
Vouchers: array
Vouchers
Title:
VouchersThe transaction vouchers resource is used to retrieve the details of loyalty vouchers that are applied to the transaction.
Nested Schema : Accrual Items
Type:
arrayTitle:
Accrual ItemsThe accrual items resource is used to retrieve the accrual items that have been updated on transaction processing.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Promotions
Type:
arrayTitle:
PromotionsThe loyalty promotions resource is used to retrieve the details of a loyalty promotion that are applied to the transaction.
Show Source
Nested Schema : Redemption Items
Type:
arrayTitle:
Redemption ItemsThe redemption items resource is used to retrieve the redemption items that have been updated on transaction processing.
Show Source
Nested Schema : Vouchers
Type:
arrayTitle:
VouchersThe transaction vouchers resource is used to retrieve the details of loyalty vouchers that are applied to the transaction.
Show Source
Nested Schema : loyTransactions-AccrualItems-item-response
Type:
Show Source
object-
AccrualedValue: number
Title:
Number of PointsThe number of accrued points. This attribute gets updated whenever the transaction creates accrual items and assigns points during transaction processing. There is no default value, dependency, or limitation associated with this attribute. -
AccrualEffDt: string
(date-time)
Title:
Accrual Start DateThe attribute indicates the effective date date of the assigned points. There is no default value, dependency, or limitation associated with this attribute. -
AccrualItemNumber: string
Title:
Item NumberMaximum Length:30The attribute is an alternate key that uniquely identifies an accrual item. There is no default value, dependency, or limitation associated with this attribute. -
ActionNote: string
Title:
Action NoteRead Only:trueMaximum Length:1000The attribute indicates additional information pertaining to an accrual action that resulted in the creation of the accrual item. There is no default value or limitation associated with this attribute. -
Active: string
Title:
ActiveRead Only:trueMaximum Length:1The accrual item active flag. This attribute is a boolean flag which indicates whether the accrual item is active or not. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Created DateRead Only:trueThe date when the accrual Item is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction. There is no default value, dependency, or limitation associated with this attribute. -
DisplayName: string
Title:
Point TypeRead Only:trueMaximum Length:30The name of the point type for which the accrual Item is created during transaction processing. There is no default value, dependency, or limitation associated with this attribute. -
ExpirationDt: string
(date-time)
Title:
Expiration DateThe date when the points accrued expire. There is no default value, dependency, or limitation associated with this attribute. -
ExpiredValue: number
The accrual items which have expired. There is no default value, dependency, or limitation associated with this attribute.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoyAcrlItmId: integer
(int64)
Title:
Loyalty Accrual Item IDThe primary key to identify an accrual item. Oracle Loyalty Cloud generates this attribute value during the creation of an accrual item while processing an accrual transaction. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
The member for whom the accrual item is created. There is no default value, dependency, or limitation associated with this attribute.
-
Name: string
Title:
Point SubtypeRead Only:trueMaximum Length:50The attribute indicates the name of the point type that is accrued by the member. There is no default value, dependency, or limitation associated with this attribute. -
NumberOfPoints: number
Title:
Number PointsRead Only:trueThe number of points that have been accrued as a result of accrual type transactions being processed. There is no default value, dependency, or limitation associated with this attribute. -
OrderNumber: string
Maximum Length:
30The number associated with an order. This attribute is used by Oracle Loyalty Cloud when consolidating transactions. There is no default value, dependency, or limitation associated with this attribute. -
PointBlkId: integer
(int64)
Title:
Point Block IDThe attribute indicates the primary key of the point block from which the accrued points are allocated to the member. There is no default value, dependency, or limitation associated with this attribute. -
ProcessDt: string
(date-time)
Title:
Processed DateThe transaction process date. This attribute specifies the day on which the created transaction is processed that resulted in creation of accrual items. There is no default value, dependency, or limitation associated with this attribute. -
ProdId: integer
(int64)
Title:
Product IDRead Only:trueThe foreign key of loyalty products. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute. -
ProductNumber: string
Read Only:
trueThe product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute. -
ProgramName: string
Read Only:
trueThe name of the program in which the transaction is created. There is no default value, dependency, or limitation associated with this attribute. -
PromoObjectVersionNumber: integer
(int32)
Title:
Object Version NumberRead Only:trueThe promotion object number associated with the accrual item. Oracle Loyalty Cloud populates this value when the point item is created in the UI. There is no default value, dependency, or limitation associated with this attribute. -
PromotionName: string
Title:
PromotionRead Only:trueMaximum Length:50The name of the promotion that has been applied and for which the accrual items are created during transaction processing. There is no default value, dependency, or limitation associated with this attribute. -
PromotionNumber: string
Title:
Promotion NumberRead Only:trueMaximum Length:30The promotion number that has been applied to the member and associated with the accrual item. There is no default value, dependency, or limitation associated with this attribute. -
QualifyingFlag: boolean
Title:
QualifyingMaximum Length:1Default Value:falseThe boolean attribute indicates whether the accrued points are qualifying points or not. Qualifying points count toward a member???s tier status. The default value is N. There is no dependency or limitation associated with this attribute. -
Status: string
Title:
Status MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for an accrual item status code and its value represents the status of the accrual item. The accepted values are: Available, Cancelled, or Expired. There is no default value, dependency, or limitation associated with this attribute. -
StatusCode: string
Title:
Status CodeMaximum Length:30The code that represents the status of the accrual item. The accepted values are ORA_LOY_AVAILABLE, ORA_LOY_CANCELLED or ORA_LOY_EXPIRED. There is no default value, dependency, or limitation associated with this attribute. -
TransactionAmount: number
Title:
AmountRead Only:trueThe currency value amount of the transaction from transactions. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute. -
TransactionNumber: string
Title:
Transaction NumberMaximum Length:30This attribute indicates the transaction number which uniquely identifies the loyalty transaction. This attribute is automatically generated by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
TypeCode: string
Title:
Type CodeMaximum Length:30The accrual item type code associated with an order. There is no default value, dependency, or limitation associated with this attribute. -
UsedValue: number
Title:
Used ValueThe total points from the accrued points that have been used. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : loyTransactions-Promotions-item-response
Type:
Show Source
object-
Active: string
Title:
ActiveRead Only:trueMaximum Length:1The active flag attribute indicates whether the promotion is active or not. The accepted values are: Y or N and the default value is N. There is no dependency or limitation associated with this attribute. -
BucketUid: string
Title:
Promotion Attribute NumberMaximum Length:30The attribute represents the bucket identifier. This attribute will be used in case of frequency promotion processing. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoyBucketId: integer
(int64)
Title:
Promotion Attribute NumberThe primary key to identify a promotion bucket. Oracle Loyalty Cloud generates this attribute value during the creation of a bucket record. There is no default value, dependency, or limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member IDThe member identifier associated with the promotion bucket. The attribute value is the primary key of the member. There is no default value, dependency, or limitation associated with this attribute. -
PromotionAttributes: array
Promotion Attributes
Title:
Promotion AttributesThe promotion attributes resource is used to retrieve the details of a promotion attribute that is updated for transaction. -
PromotionId: integer
(int64)
Title:
Promotion IDThe primary key to identify a loyalty promotion. Oracle Loyalty Cloud generates this attribute value when a new promotion is set up. There is no default value, dependency, or limitation associated with this attribute. -
PromotionName: string
Title:
PromotionRead Only:trueMaximum Length:50The name of the promotion, which can be easily remembered by the user. There is no default value, dependency, or limitation associated with this attribute. -
Status: string
Title:
Status MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for StatusCode. The accepted values are: Completed, In Progress, Updated, and so on. There is no default value, dependency, or limitation associated with this attribute. -
StatusCode: string
Title:
Status CodeMaximum Length:30The promotion status code attribute. The accepted values are: ORA_BUCKET_STATUS_COMPLETED, ORA_BUCKET_STATUS_INPROGRESS, ORA_BUCKET_STATUS_UPDATED, and so on. There is no default value, dependency, or limitation associated with this attribute. -
TransactionId: integer
(int64)
Title:
TransactionRead Only:trueThe transaction identifier associated with the promotion bucket. It is the primary key from transactions which is a foreign key for promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Promotion Attributes
Type:
arrayTitle:
Promotion AttributesThe promotion attributes resource is used to retrieve the details of a promotion attribute that is updated for transaction.
Show Source
Nested Schema : loyTransactions-Promotions-PromotionAttributes-item-response
Type:
Show Source
object-
ActionNote: string
Title:
Action NoteMaximum Length:1000The attribute indicates additional information pertaining to an action that resulted in the creation of the promotion attribute. There is no default value or limitation associated with this attribute. -
Active: string
Title:
ActiveRead Only:trueMaximum Length:1Default Value:NThe promotion attribute active flag. This attribute is a boolean flag that indicates whether the promotion attribute is active or not. There is no default value, dependency, or limitation associated with this attribute. -
AttrDefnId: integer
(int64)
Title:
Attribute Definition IDRead Only:trueThe primary key value of the loyalty attribute definitions corresponding to attribute types like pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute. -
AttribDefnId: integer
(int64)
Title:
Attribute Definition IDThe attribute definition identifier that results from transaction processing. There is no default value, dependency, or limitation associated with this attribute. -
AttrTypeCode: string
Title:
Attribute Type CodeRead Only:trueMaximum Length:30The promotion attribute type code. This attribute reflects the type of attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute. -
BucketUid: string
Title:
Alternate Loyalty Milestone IDRead Only:trueMaximum Length:30The unique key to identify a bucket record. This attribute is automatically generated by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
DataType: string
Title:
Data Type MeaningRead Only:trueMaximum Length:80The promotion attribute data type name indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute. -
DataTypeCode: string
Title:
Data TypeRead Only:trueMaximum Length:30The promotion attribute data type name indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute. -
DisplayName: string
Title:
Attribute NameRead Only:trueMaximum Length:30The promotion attribute display name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoyAttrdefnBId: integer
(int64)
Title:
Attribute Definition IDRead Only:trueThe primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute. -
LoyAttrItmId: integer
(int64)
Title:
Loyalty Attribute Item IDThe primary key of loyalty attribute items. There is no default value, dependency, or limitation associated with this attribute. -
LoyBucketId: integer
(int64)
Title:
Loyalty Milestone IDRead Only:trueThe primary key value of the loyalty bucket. Oracle Loyalty Cloud generates this attribute value when a bucket attribute is created. There is no default value, dependency, or limitation associated with this attribute. -
LoyPromoId: integer
(int64)
Title:
Loyalty Promotion IDRead Only:trueThe primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute. -
Name: string
Title:
PromotionRead Only:trueMaximum Length:50The attribute indicates name of the promotion. There is no default value, dependency, or limitation associated with this attribute. -
ObjectCode: string
Title:
Object CodeRead Only:trueMaximum Length:30The details of the object whose attribute is compared. The picklist displays only those objects that are appropriate to the value in the Rule Applies To field. The accepted values are Transaction, Member, and so on. There is no default value, dependency, or limitation associated with this attribute. -
ProcessedDt: string
(date-time)
Title:
Processed DateRead Only:trueThe attribute indicates the date of processing of bucket attribute. There is no default value, dependency or limitation associated with this attribute. -
ProcessingComment: string
Title:
CommentsRead Only:trueMaximum Length:1000The bucket processing comment that provides the details of an error, if any occurred during processing. There is no default value, dependency, or limitation associated with this attribute. -
PromoBucketId: integer
(int64)
Title:
Promotion Bucket IDThe promotion attribute bucket identifier. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute. -
PromotionId: integer
(int64)
Title:
Promotion IDRead Only:trueThe promotion attribute of the loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute. -
Status: string
Title:
Status MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for promotion attribute Status code and indicates the status of the promotion bucket transaction. The accepted values are: Completed, In Progress, Updated, and so on. There is no default value, dependency, or limitation associated with this attribute. -
StatusCode: string
Title:
StatusRead Only:trueMaximum Length:30The attribute indicates the status of the bucket transaction. The accepted values are ORA_BUCKET_STATUS_COMPLETED, and so on. There is no default value, dependency, or limitation associated with this attribute. -
TransactionId: integer
(int64)
Title:
Transaction IDThe primary key from transactions which is a foreign key for promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute. -
Value: string
Title:
Attribute ValueMaximum Length:250The value of the promotion or program attribute item. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : loyTransactions-RedemptionItems-item-response
Type:
Show Source
object-
AccrualItemNumber: string
Title:
Accrual Item NumberMaximum Length:30An alternate key that uniquely identifies an accrual item that is used in redemption. There is no default value, dependency, or limitation associated with this attribute. -
ActionNote: string
Title:
Action NoteMaximum Length:1000The attribute indicates additional information pertaining to redemption action because of which the redemption item was created. There is no default value or limitation associated with this attribute. -
AmountValue: number
Title:
AmountRead Only:trueThe currency value of the transaction which results in the creation of the redemption item when processed. There is no default value, dependency, or limitation associated with this attribute. -
Comments: string
Title:
CommentsMaximum Length:250The comments entered by user, if any, for future reference. There is no default value, dependency, or limitation associated with this attribute. -
DisplayName: string
Title:
Point TypeMaximum Length:30The name of the redemption items that are displayed to the user. Redemption items are created when a transaction of type Redemption is processed successfully. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoyRdmItmId: integer
(int64)
Title:
Loyalty Redemption Item IDThe attribute redemption item identifier is the primary key of redemption items. Oracle Loyalty Cloud generates this attribute value during the creation of a transaction record. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member NumberRead Only:trueMaximum Length:30The member for whom the redemption item is created. There is no default value, dependency, or limitation associated with this attribute. -
ObjectCode: string
Title:
Object CodeRead Only:trueMaximum Length:30The redemption item object code. This attribute indicates the object, either Member, Transaction, Promotion, Calendar, and so on, to which the attributes belong. There is no default value, dependency, or limitation associated with this attribute. -
ProcessDate: string
(date-time)
Title:
Process DateRead Only:trueThe transaction process date. This attribute specifies the day on which the created transaction is processed that resulted in the creation of the redemption items. There is no default value, dependency, or limitation associated with this attribute. -
ProgId: integer
(int64)
Title:
Product IDRead Only:trueThe foreign key for the program. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute. -
ProgramName: string
Title:
ProgramRead Only:trueMaximum Length:50The name of the program under which the transaction is created. There is no default value, dependency, or limitation associated with this attribute. -
PromotionName: string
Title:
PromotionRead Only:trueMaximum Length:50The accrual item active flag. This attribute is a boolean flag which indicates whether the accrual item is active or not. There is no default value, dependency, or limitation associated with this attribute. -
PromotionNumber: string
Title:
Promotion NumberMaximum Length:30The promotion number that has been applied to the redemption transaction. There is no default value, dependency, or limitation associated with this attribute. -
PromotionType: string
Title:
Promotion Type MeaningRead Only:trueMaximum Length:80The attribute represents the list of values meaning for the Promotion type code. The value represents the promotion type. The accepted values are: Accrual, Redemption or Tier. There is no default value, dependency, or limitation associated with this attribute. -
PromotionTypeCode: string
Title:
TypeRead Only:trueMaximum Length:30The code representing the promotion type. The accepted values are ORA_TXN_ACC, ORA_TXN_RED or ORA_TIER. There is no default value, dependency, or limitation associated with this attribute. -
RedemptionItemNumber: string
Title:
Item NumberMaximum Length:30The attribute redemption item number is an alternate key that uniquely identifies a redemption item. There is no default value, dependency, or limitation associated with this attribute. -
TransactionnNumber: string
Title:
Transaction NumberRead Only:trueMaximum Length:30This attribute indicates the transaction number which uniquely identifies the loyalty transaction. This attribute is automatically generated by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
TransactionNumber: string
Title:
Transaction NumberMaximum Length:30The transaction number that uniquely identifies the loyalty transaction. This attribute value is automatically generated. There is no default value, dependency, or limitation associated with this attribute. -
Type: string
Title:
Type MeaningRead Only:trueMaximum Length:80The attribute represents the list of values meaning for Redemption item type code. The accepted values are: Cancelled Points, Points Redeemed, and so on. There is no default value, dependency, or limitation associated with this attribute. -
TypeCode: string
Title:
Type CodeMaximum Length:30The redemption item type code. The accepted values are ORA_TXN_CNCL or ORA_TXN_RED. There is no default value, dependency, or limitation associated with this attribute. -
Value: number
Title:
Number of PointsThe value of redemption items that are redeemed. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : loyTransactions-Vouchers-item-response
Type:
Show Source
object-
ActionNote: string
Title:
Action NoteMaximum Length:1000The attribute indicates additional information pertaining to the voucher action that resulted in the creation of the voucher. There is no default value or limitation associated with this attribute. -
ActivityDate: string
The date used by Oracle Loyalty Cloud to fetch a valid voucher for a given activity date. The ActivityDate attribute is a parameter used in the availableVoucherFinder and the validateVoucherFinder finders. There is no default value, dependency, or limitation associated with this attribute.
-
Basis: string
Title:
Voucher Basis MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for the basis code and the value displays the reason why the member received the voucher. The accepted values are: Accrual, Redemption and Tier Reward. There is no default value, dependency, or limitation associated with this attribute. -
BasisCode: string
Title:
Voucher BasisMaximum Length:30The voucher assignment based on the transaction type. The accepted values are ORA_VOUC_BASIS_ACC, ORA_VOUC_BASIS_TIER, and so on. This attribute is set to ORA_VOUC_BASIS_ACC for accrual transactions and ORA_VOUC_BASIS_RED for redemption transactions. There is no default value, dependency, or limitation associated with this attribute. -
ConsumedTransactionNumber: string
Title:
Redeemed Transaction NumberMaximum Length:30The transaction number which used this voucher. There is no default value, dependency, or limitation associated with this attribute. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The details of who created the voucher. Oracle Loyalty Cloud generates this attribute value during the creation of new voucher. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the voucher was created. Oracle Loyalty Cloud generates this attribute value during the creation of a new voucher. There is no default value, dependency, or limitation associated with this attribute. -
CurcyExchDt: string
(date)
Title:
Currency Exchange DateThe currency exchange date associated with the voucher. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyAmount: number
Title:
Voucher Discount ValueThe attribute specifies the currency amount. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyCode: string
Title:
Currency CodeMaximum Length:15The currency code associated with the voucher. There is no default value, dependency, or limitation associated with this attribute. -
Description: string
Title:
TypeRead Only:trueMaximum Length:240The product description for the voucher. The user enters the description of the product as the VoucherType attribute, which is displayed as the product description on the Loyalty Voucher UI page. Oracle Loyalty Cloud assigns the ProdId attribute value with the identifier of the product when the user inputs the product description. There is no default value, dependency, or limitation associated with this attribute. -
DiscountValue: string
Read Only:
trueThe voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, the value of discount must be a positive integer. This value is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute. -
ExpirationDt: string
(date-time)
Title:
Expiration DateThe expiration date of the voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or the attribute value can be provided as an input when creating a voucher using the resource. There is no default value, dependency, or limitation associated with this attribute. -
InvOrgId: integer
(int64)
Title:
Inventory Organization IDThe unique identifier of the organization that provides the inventory when the user is redeeming the vouchers. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Change DateRead Only:trueThe date when the voucher was last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are any changes to the voucher. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Changed ByRead Only:trueMaximum Length:64The user who last updated the voucher. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the voucher take place. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoyMemVchrId: integer
(int64)
Title:
Voucher IDThe primary key to identify a loyalty voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or the value can be provided as input when creating a voucher using the resource. There is no default value, dependency, or limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member IDThe primary key of the member to whom the voucher is assigned. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member NumberThe member number of the loyMember attribute to whom the voucher is assigned. The MemberNumber attribute is used when assigning a voucher or creating a voucher using the resource. The MemberNumber attribute is also used as a parameter in the availableVoucherFinder finder. There is no default value or dependency associated with this attribute. -
Name: string
Title:
PromotionRead Only:trueMaximum Length:50The attribute indicates the name of the promotion that resulted in the creation of the voucher. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationCode: string
Title:
Organization CodeMaximum Length:18The organization code associated with the voucher. There is no default value, dependency, or limitation associated with this attribute. -
OriginalVoucherNumber: string
Title:
Original Voucher NumberMaximum Length:30The original voucher number associated with the voucher. There is no default value, dependency, or limitation associated with this attribute. -
PrConId: integer
(int64)
Title:
Primary Contact IDRead Only:trueThe attribute indicates the primary contact identifier of the member for whom the voucher was created. There is no default value, dependency, or limitation associated with this attribute. -
ProductNumber: string
Title:
Product NumberThe identifier of the product for an existing voucher for specifying product information. There is no default value, dependency, or limitation associated with this attribute. -
PromotionNumber: string
Title:
Promotion NumberMaximum Length:30The promotion number which applied to the transaction and created this voucher. There is no default value, dependency, or limitation associated with this attribute. -
Quantity: number
Title:
QuantityDefault Value:1The attribute specifies the number of vouchers. There is no default value, dependency or limitation associated with this attribute. -
StatusCode: string
Title:
StatusMaximum Length:30Default Value:ORA_VOUC_STATUS_AVLBLThe attribute indicates the status of the voucher. The accepted values are ORA_VOUC_STATUS_AVLBL, ORA_VOUC_STATUS_USED, ORA_VOUC_STATUS_CANC, and so on. The VoucherStatus attribute can be changed from Available to Used only through a PATCH request. There is no default value, dependency, or limitation associated with this attribute. -
StatusMeaning: string
Title:
Voucher Status MeaningRead Only:trueMaximum Length:80The attribute represents the list of values meaning for status code of the voucher. The accepted values are: Available, Used, Cancelled, and so on. There is no default value, dependency, or limitation associated with this attribute. -
TxnId: integer
(int64)
Title:
Transaction IDRead Only:trueThe attribute is the foreign key of the transaction which uniquely identifies the transaction that caused the voucher to be assigned to a member. There is no default value, dependency or limitation associated with this attribute. -
TxnItemId: integer
(int64)
Title:
Transaction Item IDThe transaction item identifier attribute displays the details that caused the voucher to be generated. There is no default value, dependency or limitation associated with this attribute. -
TxnNum: string
Title:
Transaction NumberRead Only:trueMaximum Length:30The transaction number attribute is an alternate key that uniquely identifies a transaction to which the voucher belongs. There is no default value, dependency or limitation associated with this attribute. -
UsedDt: string
(date-time)
Title:
Used DateThe date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute. -
validFlag: boolean
The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.
-
VchrBasis: string
Title:
Discount Type MeaningRead Only:trueMaximum Length:80The attribute represents the list of value meaning for voucher basis code. The attribute indicates the discount type that the voucher offers. The accepted values are: Absolute Value or Percentage. It is provided as input from a user when creating the voucher. There is no default value, dependency, or limitation associated with this attribute. -
VchrBasisCode: string
Title:
Discount TypeMaximum Length:30The attribute indicates the discount type that the voucher offers. Accepted values are ORA_VOUC_BASIS_ABSOLUTE or ORA_VOUC_BASIS_PERCENTAGE. It is provided as input from a user when creating the voucher. There is no default value, dependency, or limitation associated with this attribute. -
VoucherDiscountValue: number
Title:
Voucher Discount ValueThe voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, then the value of discount must be a positive integer. This value is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute. -
VoucherEffectiveStartDt: string
(date)
Title:
Start DateThe date when the voucher is in effect. This date is assigned during an Assign Voucher action or when the voucher is created using the resource. There is no default value, dependency, or limitation associated with this attribute. -
VoucherNumber: string
Title:
Voucher NumberMaximum Length:30The alternative way to identify a voucher. The UI shows the voucher number but the VoucherNumber attribute is used in the URI to update a voucher record using the resource. The VoucherNumber attribute can also be used as parameter for the validateVoucherFinder finder. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- cancelTransaction
-
This custom action cancels a loyalty transaction through the loyalty engine by evaluating the rules applied to the given transaction number.
- processTransaction
-
This custom action processes a loyalty transaction through the loyalty engine by evaluating the rules applied to the given transaction number.
Examples
This example shows how to retrieve all the transactions in your loyalty system.
Use GET with the following URI syntax to retrieve all the transactions:
https://example.com:portcrmRestApi/resources/11.13.18.05/loyaltyTransactions
Example of Response Header
cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -11030
content-type -application/vnd.oracle.adf.resourcecollection+json
date -Thu, 23 Aug 2018 19:53:42 GMT
keep-alive -timeout=61, max=100
link - <https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions>;rel="self";kind="collection";name="loyTransactions"
location -
rest-framework-version -1
server -Oracle-HTTP-Server
vary -User-Agent
x-content-type-options -nosniff
x-oracle-dms-ecid -005T1yTk1x2EoIILIqL6if0001wh0000l4Example of Response Body
{
"items": [
{
"LoyTransactionId": 300100129329995,
"TransactionNumber": "300100129329995",
"TransactionDate": "2018-08-23T00:00:00+00:00",
"TypeCode": "ORA_TXN_ACC",
"SubTypeCode": "ORA_ACC_PROD",
"StatusCode": "ORA_TXN_STAT_PROCESSED",
"ActivityDay": null,
"ActivityHour": null,
"AdjustedListPrice": null,
"AmountValue": 100,
"ApproveDt": null,
"BidTransaction": "N",
"BookClassCode": null,
"BookingDt": null,
"BulkReferenceId": null,
"CancReasonCode": null,
"CancelledTransactionId": null,
"ChildTransactionId": null,
"Comments": null,
"CorporateReferenceNumber": null,
"CreatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
"CreationDate": "2018-08-23T19:47:55+00:00",
"CurcyCode": "USD",
"CurcyExchDt": null,
"DestAirportCode": null,
"DestCityCode": null,
"DestZoneCode": null,
"DocumentNumber": null,
"EndDt": null,
"EnrolPromoId": null,
"ExpireInDays": null,
"ExternalReservationNumber": null,
"ExternalTransaction": "N",
"FareBasis": null,
"FareBasisCode": null,
"FareTypeCode": null,
"FlightNumber": null,
"FltTypeCode": null,
"GdsRecLocator": null,
"IncentivChoice": null,
"InternalDest": null,
"InternalFlightDt": null,
"InternalOrigin": null,
"ItemNumber": null,
"LastUpdateDate": "2018-08-23T19:47:57.044+00:00",
"LastUpdateLogin": "74078F0F807BA1E3E05334C4F00A77B7",
"LastUpdatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
"LoanBalance": null,
"LoanRepaymentDt": null,
"LocationCode": null,
"LocationName": null,
"MarketingFlightNumber": null,
"Points": 11,
"OperFltNum": null,
"OptyCost": null,
"OrderNumber": null,
"OrderQuantity": null,
"OrigAirportCode": null,
"OrigAmount": null,
"OrigOrdItmId": null,
"OrigOrderId": null,
"OrigPoints": null,
"OrigZoneCode": null,
"OriginCityCode": null,
"OvrDupCheck": "N",
"PriceOverriden": "N",
"OwnerId": null,
"PackageCode": null,
"ParentTransactionId": null,
"PartitionName": null,
"PeriodDurCode": null,
"PeriodTypeCode": null,
"PnrName": null,
"PostDt": null,
"ProcFlowId": null,
"ProcessDt": "2018-08-23T19:47:57.238+00:00",
"ProcessingComment": null,
"ProcessingLog": "Assigned Points: 100.0 Bits, Expiry Date: null (Bits Per Dollar)<br>',
"PtnrProcDt": null,
"PtnrStatusCode": null,
"PymtTypeCode": null,
"QualifyingPointUsed": "N",
"RdmItmId": null,
"RedemptionQuantity": null,
"RedemptionQuantityUOMCode": null,
"ReasonCode": null,
"RefundBasisCode": null,
"RefundPct": null,
"RfndOvrdCmnts": null,
"RfndOvrdRsnCode": null,
"SmActionTypeCode": null,
"SourceCode": null,
"StartDt": "2018-08-23T19:47:55.657+00:00",
"SubStatusCode": "ORA_TXN_SUB_STAT_SUCCESS",
"SubmitDt": null,
"TaxAmount": null,
"TicketNumber": null,
"ToMemberNumber": null,
"TotalLines": null,
"TrvClassCode": null,
"TrvlDistance": null,
"TransactionChannelCode": null,
"TransactionSourceCode": null,
"UnaccMinor": "N",
"ValStatusCode": null,
"VoucherQuantity": null,
"ActivityDate": "2018-08-23T19:47:55.657+00:00",
"PaymentType": null,
"InvOrgId": 204,
"LineItemNumber": null,
"PnrNumber": null,
"Description": "Pro 400",
"CorpRefName": null,
"CurcyConvRateType": "Corporate",
"CorpCurrencyCode": "USD",
"MemberNumber": "300100129329081",
"PointTypeName": null,
"TransferPoints": null,
"TransferToMember": null,
"ExternalProductName": null,
"ExternalProductType": null,
"ExternalProductLine": null,
"TotalDays": null,
"CorpRefMemberId": null,
"CorpRefMemberType": null,
"ProgramName": "A2Z Bank",
"PrConId": 300100129329082,
"DisplayName": null,
"LoyAttrdefnBId": null,
"ProductNumber": "CRMITEM-AS54888-00182745",
"PartnerNumber": null,
"PartyNumber": null,
"AccrualDisputeStatusCode": null,
"AccrualDisputeTypeCode": null,
"AccrualDisputedTransactionNumber": null,
"AccItmList": "[{\"PointTypeName\":\"Bits\",\"LoyAttrdefnBId\":300100129323724,\"AccrualedValue\":100}]",
"links": [
{
"rel": "self",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995",
"name": "loyTransactions",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995",
"name": "loyTransactions",
"kind": "item"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/ProgramPVO2",
"name": "ProgramPVO2",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionTravelClassPVO1",
"name": "TransactionTravelClassPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionAirlineZonePVO1",
"name": "TransactionAirlineZonePVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionStatusPVO1",
"name": "TransactionStatusPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/SocialActionPVO1",
"name": "SocialActionPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransferToLOV",
"name": "TransferToLOV",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionAirportPVO1",
"name": "TransactionAirportPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/PointTypePVO3",
"name": "PointTypePVO3",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/PartyPVO1",
"name": "PartyPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/RatedCurrenciesVO",
"name": "RatedCurrenciesVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/ExternalProductLinePVO1",
"name": "ExternalProductLinePVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/BookClassPVO1",
"name": "BookClassPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionTypeCodeLookupPVO1",
"name": "TransactionTypeCodeLookupPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionPVO1",
"name": "TransactionPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/MemberPVO4",
"name": "MemberPVO4",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/SalesCatalogProductProgPVO2",
"name": "SalesCatalogProductProgPVO2",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/SalesCatalogProductProgPVO1",
"name": "SalesCatalogProductProgPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/MemberNameProgramPVO1",
"name": "MemberNameProgramPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionSubStatusPVO1",
"name": "TransactionSubStatusPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionPaymentTypePVO1",
"name": "TransactionPaymentTypePVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionSourcePVO1",
"name": "TransactionSourcePVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionSubTypePVO1",
"name": "TransactionSubTypePVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionDisputeStatusLookupPVO1",
"name": "TransactionDisputeStatusLookupPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/ExternalProductTypePVO1",
"name": "ExternalProductTypePVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionChannelPVO1",
"name": "TransactionChannelPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/FareBasisPVO1",
"name": "FareBasisPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionFareTypePVO1",
"name": "TransactionFareTypePVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/lov/TransactionDisputeTypeLookupPVO1",
"name": "TransactionDisputeTypeLookupPVO1",
"kind": "collection"
},
{
"rel": "child",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/child/RedemptionItems",
"name": "RedemptionItems",
"kind": "collection"
},
{
"rel": "child",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/child/AccrualItems",
"name": "AccrualItems",
"kind": "collection"
},
{
"rel": "child",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/child/Promotions",
"name": "Promotions",
"kind": "collection"
},
{
"rel": "child",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions/300100129329995/child/Vouchers",
"name": "Vouchers",
"kind": "collection"
}
]
},
.
.
.
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyTransactions",
"name": "loyTransactions",
"kind": "collection"
}
]
}