Update a loyalty transaction (Deprecated)

patch

/crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}

Request

Path Parameters
  • 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.
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type: object
Show Source
  • (Deprecated) Accrual Items
    Title: (Deprecated) Accrual Items
    The accrual items resource is used to retrieve the accrual items that have been updated on transaction processing.
  • Title: Activity Date
    The date when a transaction activity occurs. The transaction can be either an accrual or redemption transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Activity Day
    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.
  • Title: Activity Hour
    The transaction activity hour. This attribute represents the time in hours when an activity, either accrual or redemption, occurs. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Adjusted List Price
    The currency that displays the redemption price that is used during redemption. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Amount
    The total amount spent on the accrual or redemption transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Approve Date
    The transaction approval date. If the transactions involve an approval process, then the identifier indicates the date when transaction is approved by the reviewer. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Bid
    Maximum Length: 1
    The transaction bid. This attribute is populated with a value if the created transaction is a bid transaction. A bid transaction occurs mainly through a third party UI, for example, Web Services. There is no default value, dependency, or limitation associated with this attribute.
  • The booking class name. This attribute specifies the class of the airline ticket. The accepted values are Economy, Business Class, or First Class. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Booking Date
    The transaction booking date. If the transaction is an airline transaction, then this attribute indicates the date when the booking is made for travel. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Bid
    The transaction business unit identifier. Oracle Loyalty Cloud generates this attribute value when it creates the transaction record. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Reference Member Bulk Actions
    The bulk reference number associated with the transaction when the transaction is created as the result of a bulk transaction creation. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Canceled Transaction ID
    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.
  • Title: Cancellation Reason Code
    Maximum Length: 30
    The cancellation reason code. This attribute value represents the reason why the transaction is canceled. There is no default value, dependency, or limitation associated with this attribute.
  • The transaction channel name. This attribute indicates the means by which the transaction occurs. The accepted values are Web, Mobile, or Phone. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Comments
    Maximum Length: 250
    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.
  • Title: Corporate Reference Number
    Maximum Length: 30
    The reference to a third-party corporate member from the program to get the points split for the individual and the corporation or company, if an individual member completes a transaction on behalf of the corporation or company. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Currency Code
    Maximum Length: 20
    The transaction currency code. This attribute indicates the currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value or dependency associated with this attribute.
  • Title: Currency Exchange Date
    The date when the currency exchange occurs during the transaction creation. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Destination City
    Maximum Length: 30
    The destination city code. The attribute value represents the city where the flight arrives when it reaches its destination. There is no default value, dependency, or limitation associated with this attribute.
  • The destination airport name. The attribute value is the name of the airport where the flight arrives when it reaches its destination. There is no default value, dependency, or limitation associated with this attribute.
  • The destination zone name. This attribute value is the name of the zone where the flight arrives when it reaches its destination. The accepted values are Asia, Europe, or North America. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Document Number
    Maximum Length: 30
    The document number associated with the transaction. This attribute provides additional information in the transaction for the retail industry. There is no default value, dependency, or limitation associated with this attribute.
  • Title: End Date
    The transaction end date. This attribute is the date when the transaction is no longer in effect. This attribute value, if provided, must be set to a value after the StartDt attribute. There is no default value or dependency associated with this attribute.
  • Title: Enrolled Promotion ID
    The enrolled promotion identifier. This attribute provides the promotion identifier of the enrolled promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Expires in Days
    The date when the accrued points will expire, in days. There is no default value, dependency, or limitation associated with this attribute.
  • Title: External Product Name
    Maximum Length: 240
    The product name reference in the external system. There is no default value, dependency, or limitation associated with this attribute.
  • Title: External Reservation Number
    Maximum Length: 250
    The external reservation number is specific to the airline industry where a reservation is performed by an agent and has different reservation numbers. There is no default value, dependency, or limitation associated with this attribute.
  • Title: External
    Maximum Length: 1
    Default Value: N
    The details of the transaction coming from a partner???s external application into loyalty when loyalty is integrated with a third-party application. There is no default value, dependency, or limitation associated with this attribute.
  • The product line associated with the product for the transaction that is from an external source. There is no default value, dependency, or limitation associated with this attribute.
  • The type of products coming into the Oracle Loyalty Cloud system from an external source. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Fare Basis Code
    Maximum Length: 30
    The transaction fare basis. This attribute is a code which represents the fare basis on which the ticket fare is based. The accepted values are ORA_FARE_BASIS_BUSI or ORA_FARE_BASIS_ECO. There is no default value, dependency, or limitation associated with this attribute.
  • The fare basis name. This attribute is the basis for the ticket fare. The accepted values are Business or Economy. There is no default value, dependency, or limitation associated with this attribute.
  • The fare type name. This attribute value determines the ticket fare. The accepted values are Business Class or First Class. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Flight Number
    Maximum Length: 30
    The transaction flight number. If the transaction pertains to airlines, then this attribute indicates the flight number of the flight where the travel takes place. This attribute is input by the user during transaction creation. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Flight Type Code
    Maximum Length: 30
    The attribute specifies the flight type, for example, Boeing or Airbus. There is no default value, dependency, or limitation associated with this attribute.
  • Title: GDS Record Locator
    Maximum Length: 30
    The global distribution system (GDS) record locator. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Incentive Choice
    Maximum Length: 30
    The incentives or rewards that a member receives for enrolling into a promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Internal Destination
    Maximum Length: 15
    The details of the destination that is used internally by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Internal Flight Date
    The local date for the flight for the country. For example, 24/01/2018 is equal to GMT +5.30 in India. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Internal Origin
    Maximum Length: 15
    The flight origin details that are local to the region. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Inventory Organization ID
    The organization from where inventory is being picked. For example, when a transaction is created, sometimes the inventory or goods are picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is being picked from a different organization. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Item Number
    Maximum Length: 30
    The transaction item number that is used during transaction creation. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Order Line Number
    The line item number for a multiple line item order transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Loan Balance
    The remaining balance of the loan that you can use during transaction creation. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Loan Repayment Date
    The date which specifies when the loan is repaid. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Location ID
    The transaction location code which is used for giving promotions only for specific locations. For example, for the same retailer, the promotion can be applied only if the store is located in India. If the store is located outside India, then no promotions are applied. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Location Code
    Maximum Length: 30
    The 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.
  • Title: Marketing Flight Number
    Maximum Length: 30
    The marketing flight number, which is specific to the airline industry and which indicates the flight number used in the airline's marketing campaign. There is no default value, dependency, or limitation associated with this attribute.
  • The object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Operating Flight Number
    Maximum Length: 30
    The operating flight number used in airline transactions. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Opportunity Cost
    The transaction opportunity cost associated with the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Order Number
    Maximum Length: 30
    The number associated with an order. This attribute is used by Oracle Loyalty Cloud when consolidating transactions. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Order Quantity
    The transaction order quantity. This attribute indicates the number of points for which the order is placed. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Original Amount
    The total transaction amount without any discount applied in the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • The name of the airport where the flight arrives on reaching its destination. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Origin City Code
    Maximum Length: 30
    The origin city code. This attribute value represents the city from where the flight departs. There is no default value, dependency, or limitation associated with this attribute.
  • The name of the zone from where the flight departs. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Original Order Line Item
    The details of the order item that is originally placed, especially used for exchanges, and so on in retail transactions. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Original Point
    The original value of the transaction in points without any subsequent bonus added by each promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Duplicate Check Overridden
    Maximum Length: 1
    Default Value: N
    The flag that indicates whether duplicate line items are allowed in a transaction or not. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Package Code
    Maximum Length: 30
    The transaction package code. This attribute identifies the package from which line items are picked. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Partner Transaction ID
    The transaction identifier for the parent transaction that creates the current transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Partition Name
    Maximum Length: 30
    The transaction partition name. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Partner Number
    The 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.
  • The payment type name that corresponds to the payment type code. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Period Duration
    Maximum Length: 30
    The period duration code which specifies the duration in days, or months, and so on. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Period Type
    Maximum Length: 30
    The period type code. Period type options are Months, Years, Lifetime, and so on. There is no default value, dependency, or limitation associated with this attribute.
  • Title: PNR Name
    Maximum Length: 50
    The transaction passenger name record (PNR) name. There is no default value, dependency, or limitation associated with this attribute.
  • Title: PNR Number
    Maximum Length: 50
    The transaction passenger name record (PNR) number. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Number Points
    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.
  • Title: Point Type Name
    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.
  • Title: Post Date
    The date when the transaction is posted. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Price Overridden
    Maximum Length: 1
    Default Value: N
    The flag that indicates whether the price need to be overridden or not. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Process Date
    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.
  • Title: Processing Comment
    Maximum Length: 1000
    The transaction processing comment that provides the details of an error, if any occurred, during transaction processing. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Processing Log
    Maximum Length: 1000
    The transaction processing log that provides details of all the promotions that are applied, all the points that are assigned, and all the vouchers that are assigned, if any. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Process Flow ID
    The promotion process flow identifier used for promotion flow setup. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Product Number
    The product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Loyalty Promotions
    Title: (Deprecated) Loyalty Promotions
    The loyalty promotions resource is used to retrieve the details of a loyalty promotion that is applied to the transaction.
  • Title: Partner Processing Date
    The date on which the transaction is processed at the partner end. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Partner Status Code
    Maximum Length: 30
    The status code used by the partner on processing the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Payment Type
    Maximum Length: 30
    The payment type code specifies how the payment is made for the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Qualifying
    Maximum Length: 1
    Default Value: N
    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.
  • Title: Reason Code
    Maximum Length: 30
    The reason for the cancellation or refund, if the transaction is cancelled. For example, a fee that is inadvertently applied. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Redemption Items
    Title: (Deprecated) Redemption Items
    The redemption items resource is used to retrieve the redemption items that have been updated on transaction processing.
  • Title: Redemption Quantity
    The product quantity that is redeemed in a redemption transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Unit of Measure for the Redemption Quantity
    Maximum Length: 30
    The redemption products quantity unit of measure (UOM) code. For example, possible UOM codes are kilograms or litres. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Refund Basis
    Maximum Length: 30
    The basis for the refund, in the event of cancellation of transaction. The refund options are Prorated, Percentage, or No Refunds. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Refund Percentage
    The percentage of the refund that is granted in the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Refund Override Comments
    Maximum Length: 250
    The refund override comments in the event a refund is made. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Refund Override Reason
    Maximum Length: 30
    The refund override reason code in the event a refund is made. There is no default value, dependency, or limitation associated with this attribute.
  • The social media action name. The accepted values are Check-in, Rate, Share. There is no default value, dependency, or limitation associated with this attribute.
  • The name corresponding to the source code. The accepted values are Web, Mobile, or Billing. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Start Date
    The transaction start date. Either Oracle Loyalty Cloud generates this attribute value when a new transaction is created and populates the attribute with the current date, or it is provided as input from the user when creating transaction using the resource. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Status Code
    Maximum Length: 30
    Default Value: ORA_TXN_STAT_IN_PROG
    The transaction status code values returned from look type ORA_LOY_TXN_STATUS. The default value is ORA_TXN_STAT_IN_PROG.
  • Title: Submit Date
    The transaction submission date. Oracle Loyalty Cloud assigns this attribute value when the transaction is submitted for approval by changing the Transaction Status attribute value to Submitted. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Submit to ID
    The submit to identifier contains the details of the partner reviewer that approves the transaction. This attribute is input by the user. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Tax Amount
    The amount of tax that must be paid for the completed transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Ticket Number
    Maximum Length: 30
    The unique number that is used to identify the ticket booking for an airline transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Recipient Membership Number
    Maximum Length: 30
    The unique identification number of the member to whom points are transferred. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Total Days
    The total days that are required for travel between the source and destination locations. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Total Lines
    The total line items for the transaction. A transaction can include many order line items. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transaction Date
    The date when the transaction is completed. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transaction Source Code
    Maximum Length: 30
    The transaction source code attribute indicates the transaction activity type like Airlines, Hotels, Car Rental, and so on. There is no default value, dependency, or limitation associated with this attribute.
  • The name of the transaction status code. The accepted values are In Progress, Processed, or Rejected. There is no default value, dependency, or limitation associated with this attribute.
  • The name of the transaction substatus code. The accepted values are Success, No Promotions Qualified, Insufficient Member Balance, Insufficient Point Blocks. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Transaction Vouchers
    Title: (Deprecated) Transaction Vouchers
    The transaction vouchers resource is used to retrieve the details of loyalty vouchers that are applied to the transaction.
  • Title: Transfer Member
    The unique identification number of the member from whom points are transferred. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transfer Transaction ID
    The unique identification number of the transaction that is during transfer points. There is no default value, dependency, or limitation associated with this attribute.
  • The travel class name that indicates the class of travel. The accepted values are Business, Economy. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Travel Distance
    The transaction travel distance. This attribute stores the total miles travelled. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Unaccounted Minor
    Maximum Length: 1
    Default Value: N
    The unaccounted transaction for a minor, that is below the age of majority. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Value Status Code
    Maximum Length: 30
    The status of the validation performed on the record. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Voucher Quantity
    The quantity of vouchers that are assigned because of the given transaction after processing. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : (Deprecated) Accrual Items
Type: array
Title: (Deprecated) Accrual Items
The accrual items resource is used to retrieve the accrual items that have been updated on transaction processing.
Show Source
Nested Schema : (Deprecated) Loyalty Promotions
Type: array
Title: (Deprecated) Loyalty Promotions
The loyalty promotions resource is used to retrieve the details of a loyalty promotion that is applied to the transaction.
Show Source
Nested Schema : (Deprecated) Redemption Items
Type: array
Title: (Deprecated) Redemption Items
The redemption items resource is used to retrieve the redemption items that have been updated on transaction processing.
Show Source
Nested Schema : (Deprecated) Transaction Vouchers
Type: array
Title: (Deprecated) Transaction Vouchers
The transaction vouchers resource is used to retrieve the details of loyalty vouchers that are applied to the transaction.
Show Source
Nested Schema : loyaltyTransactions-AccrualItems-item-patch-request
Type: object
Show Source
  • Title: Number of Points
    The number of accrued points. This attribute gets updated whenever the transaction creates accrual items and assigns points during transaction processing. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Expiration Date
    The date when the points accrued expire. There is no default value, dependency, or limitation associated with this attribute.
  • The primary key of loyalty accrual Items. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • The accrual item version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Promotion ID
    The foreign key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Status Code
    Maximum Length: 30
    The code that represents the status of the accrual item. The accepted values are ORA_LOY_AVAILABLE, ORA_LOY_CANCELLED or ORA_LOY_EXPIRED. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transaction ID
    The foreign key for transactions. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Used Value
    The total points used to date from the accrued points. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyaltyTransactions-Promotions-item-patch-request
Type: object
Show Source
  • Title: Loyalty Milestone ID
    The primary key to identify a loyalty bucket transaction. Oracle Loyalty Cloud generates this attribute value when a bucket is created based on the promotion setup. There is no default value, dependency, or limitation associated with this attribute.
  • The promotion version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • PromotionAttributes
  • Title: Status Code
    Maximum Length: 30
    The promotion status code that represents the status of the promotion. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : PromotionAttributes
Type: array
Show Source
Nested Schema : loyaltyTransactions-Promotions-PromotionAttributes-item-patch-request
Type: object
Show Source
  • The attribute definition identifier that results from transaction processing. There is no default value, dependency, or limitation associated with this attribute.
  • The primary key of loyalty attribute items. There is no default value, dependency, or limitation associated with this attribute.
  • The promotion attribute bucket identifier. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • The 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.
  • 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.
  • Maximum Length: 250
    The value of the promotion or program attribute item. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyaltyTransactions-RedemptionItems-item-patch-request
Type: object
Show Source
  • Title: Accrual Item ID
    The redemption item accrual item identifier. This attribute reflects the accrual item identifier, from which the points are redeemed. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Loyalty Redemption Item ID
    The primary key of loyalty redemption items. The redemption items are created when a transaction that is of type Redemption is processed successfully resulting in redeeming accrued points. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Object Version Number
    The redemption item version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Process Date
    The date when the transaction that resulted in the creation of the redemption is processed. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transaction ID
    The primary key from transactions which is a foreign key for redemption items. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Type Code
    Maximum Length: 30
    The 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.
  • Title: Redemption Item Value
    The value of redemption items that are redeemed. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyaltyTransactions-TransactionVouchers-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : loyaltyTransactions-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    The list of accrual items resulting in a transaction after processing an accrual transaction. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Accrual Items
    Title: (Deprecated) Accrual Items
    The accrual items resource is used to retrieve the accrual items that have been updated on transaction processing.
  • Title: Activity Date
    The date when a transaction activity occurs. The transaction can be either an accrual or redemption transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Activity Day
    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.
  • Title: Activity Hour
    The transaction activity hour. This attribute represents the time in hours when an activity, either accrual or redemption, occurs. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Adjusted List Price
    The currency that displays the redemption price that is used during redemption. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Amount
    The total amount spent on the accrual or redemption transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Approve Date
    The transaction approval date. If the transactions involve an approval process, then the identifier indicates the date when transaction is approved by the reviewer. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Bid
    Maximum Length: 1
    The transaction bid. This attribute is populated with a value if the created transaction is a bid transaction. A bid transaction occurs mainly through a third party UI, for example, Web Services. There is no default value, dependency, or limitation associated with this attribute.
  • The booking class name. This attribute specifies the class of the airline ticket. The accepted values are Economy, Business Class, or First Class. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Booking Date
    The transaction booking date. If the transaction is an airline transaction, then this attribute indicates the date when the booking is made for travel. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Bid
    The transaction business unit identifier. Oracle Loyalty Cloud generates this attribute value when it creates the transaction record. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Reference Member Bulk Actions
    The bulk reference number associated with the transaction when the transaction is created as the result of a bulk transaction creation. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Canceled Transaction ID
    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.
  • Title: Cancellation Reason Code
    Maximum Length: 30
    The cancellation reason code. This attribute value represents the reason why the transaction is canceled. There is no default value, dependency, or limitation associated with this attribute.
  • The transaction channel name. This attribute indicates the means by which the transaction occurs. The accepted values are Web, Mobile, or Phone. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Comments
    Maximum Length: 250
    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.
  • Title: Corporate Reference Number
    Maximum Length: 30
    The reference to a third-party corporate member from the program to get the points split for the individual and the corporation or company, if an individual member completes a transaction on behalf of the corporation or company. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The details of who creates the transaction. Oracle Loyalty Cloud generates this attribute value during the creation of new transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Creation Date
    Read Only: true
    The date when the transaction is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Currency Code
    Maximum Length: 20
    The transaction currency code. This attribute indicates the currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value or dependency associated with this attribute.
  • Title: Currency Exchange Date
    The date when the currency exchange occurs during the transaction creation. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Destination City
    Maximum Length: 30
    The destination city code. The attribute value represents the city where the flight arrives when it reaches its destination. There is no default value, dependency, or limitation associated with this attribute.
  • The destination airport name. The attribute value is the name of the airport where the flight arrives when it reaches its destination. There is no default value, dependency, or limitation associated with this attribute.
  • The destination zone name. This attribute value is the name of the zone where the flight arrives when it reaches its destination. The accepted values are Asia, Europe, or North America. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Document Number
    Maximum Length: 30
    The document number associated with the transaction. This attribute provides additional information in the transaction for the retail industry. There is no default value, dependency, or limitation associated with this attribute.
  • Title: End Date
    The transaction end date. This attribute is the date when the transaction is no longer in effect. This attribute value, if provided, must be set to a value after the StartDt attribute. There is no default value or dependency associated with this attribute.
  • Title: Enrolled Promotion ID
    The enrolled promotion identifier. This attribute provides the promotion identifier of the enrolled promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Expires in Days
    The date when the accrued points will expire, in days. There is no default value, dependency, or limitation associated with this attribute.
  • Title: External Product Name
    Maximum Length: 240
    The product name reference in the external system. There is no default value, dependency, or limitation associated with this attribute.
  • Title: External Reservation Number
    Maximum Length: 250
    The external reservation number is specific to the airline industry where a reservation is performed by an agent and has different reservation numbers. There is no default value, dependency, or limitation associated with this attribute.
  • Title: External
    Maximum Length: 1
    Default Value: N
    The details of the transaction coming from a partner???s external application into loyalty when loyalty is integrated with a third-party application. There is no default value, dependency, or limitation associated with this attribute.
  • The product line associated with the product for the transaction that is from an external source. There is no default value, dependency, or limitation associated with this attribute.
  • The type of products coming into the Oracle Loyalty Cloud system from an external source. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Fare Basis Code
    Maximum Length: 30
    The transaction fare basis. This attribute is a code which represents the fare basis on which the ticket fare is based. The accepted values are ORA_FARE_BASIS_BUSI or ORA_FARE_BASIS_ECO. There is no default value, dependency, or limitation associated with this attribute.
  • The fare basis name. This attribute is the basis for the ticket fare. The accepted values are Business or Economy. There is no default value, dependency, or limitation associated with this attribute.
  • The fare type name. This attribute value determines the ticket fare. The accepted values are Business Class or First Class. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Flight Number
    Maximum Length: 30
    The transaction flight number. If the transaction pertains to airlines, then this attribute indicates the flight number of the flight where the travel takes place. This attribute is input by the user during transaction creation. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Flight Type Code
    Maximum Length: 30
    The attribute specifies the flight type, for example, Boeing or Airbus. There is no default value, dependency, or limitation associated with this attribute.
  • Title: GDS Record Locator
    Maximum Length: 30
    The global distribution system (GDS) record locator. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Incentive Choice
    Maximum Length: 30
    The incentives or rewards that a member receives for enrolling into a promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Internal Destination
    Maximum Length: 15
    The details of the destination that is used internally by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Internal Flight Date
    The local date for the flight for the country. For example, 24/01/2018 is equal to GMT +5.30 in India. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Internal Origin
    Maximum Length: 15
    The flight origin details that are local to the region. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Inventory Organization ID
    The organization from where inventory is being picked. For example, when a transaction is created, sometimes the inventory or goods are picked from the partner and directly delivered to the customer. That is, the transaction is created for one organization, but the inventory is being picked from a different organization. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Item Number
    Maximum Length: 30
    The transaction item number that is used during transaction creation. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Update Date
    Read Only: true
    The date when the transaction is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are any changes to the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the transaction. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the transaction take place. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the transaction take place. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Order Line Number
    The line item number for a multiple line item order transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Title: Loan Balance
    The remaining balance of the loan that you can use during transaction creation. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Loan Repayment Date
    The date which specifies when the loan is repaid. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Location ID
    The transaction location code which is used for giving promotions only for specific locations. For example, for the same retailer, the promotion can be applied only if the store is located in India. If the store is located outside India, then no promotions are applied. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Location Code
    Maximum Length: 30
    The 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.
  • Title: Loyalty Transaction ID
    The primary key to identify a transaction. Oracle Loyalty Cloud generates this attribute value during the creation of a transaction record. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Marketing Flight Number
    Maximum Length: 30
    The marketing flight number, which is specific to the airline industry and which indicates the flight number used in the airline's marketing campaign. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Member Number
    The member for whom the transaction is created. There is no default value, dependency, or limitation associated with this attribute.
  • The object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Operating Flight Number
    Maximum Length: 30
    The operating flight number used in airline transactions. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Opportunity Cost
    The transaction opportunity cost associated with the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Order Number
    Maximum Length: 30
    The number associated with an order. This attribute is used by Oracle Loyalty Cloud when consolidating transactions. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Order Quantity
    The transaction order quantity. This attribute indicates the number of points for which the order is placed. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Original Amount
    The total transaction amount without any discount applied in the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • The name of the airport where the flight arrives on reaching its destination. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Origin City Code
    Maximum Length: 30
    The origin city code. This attribute value represents the city from where the flight departs. There is no default value, dependency, or limitation associated with this attribute.
  • The name of the zone from where the flight departs. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Original Order Line Item
    The details of the order item that is originally placed, especially used for exchanges, and so on in retail transactions. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Original Point
    The original value of the transaction in points without any subsequent bonus added by each promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Duplicate Check Overridden
    Maximum Length: 1
    Default Value: N
    The flag that indicates whether duplicate line items are allowed in a transaction or not. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Package Code
    Maximum Length: 30
    The transaction package code. This attribute identifies the package from which line items are picked. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Partner Transaction ID
    The transaction identifier for the parent transaction that creates the current transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Partition Name
    Maximum Length: 30
    The transaction partition name. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Partner Number
    The 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.
  • The payment type name that corresponds to the payment type code. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Period Duration
    Maximum Length: 30
    The period duration code which specifies the duration in days, or months, and so on. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Period Type
    Maximum Length: 30
    The period type code. Period type options are Months, Years, Lifetime, and so on. There is no default value, dependency, or limitation associated with this attribute.
  • Title: PNR Name
    Maximum Length: 50
    The transaction passenger name record (PNR) name. There is no default value, dependency, or limitation associated with this attribute.
  • Title: PNR Number
    Maximum Length: 50
    The transaction passenger name record (PNR) number. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Number Points
    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.
  • Title: Point Type Name
    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.
  • Title: Post Date
    The date when the transaction is posted. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Price Overridden
    Maximum Length: 1
    Default Value: N
    The flag that indicates whether the price need to be overridden or not. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Process Date
    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.
  • Title: Processing Comment
    Maximum Length: 1000
    The transaction processing comment that provides the details of an error, if any occurred, during transaction processing. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Processing Log
    Maximum Length: 1000
    The transaction processing log that provides details of all the promotions that are applied, all the points that are assigned, and all the vouchers that are assigned, if any. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Process Flow ID
    The promotion process flow identifier used for promotion flow setup. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Product Number
    The product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Program Name
    The transaction program name. This attribute indicates for which the program the transaction is created. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Loyalty Promotions
    Title: (Deprecated) Loyalty Promotions
    The loyalty promotions resource is used to retrieve the details of a loyalty promotion that is applied to the transaction.
  • Title: Partner Processing Date
    The date on which the transaction is processed at the partner end. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Partner Status Code
    Maximum Length: 30
    The status code used by the partner on processing the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Payment Type
    Maximum Length: 30
    The payment type code specifies how the payment is made for the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Qualifying
    Maximum Length: 1
    Default Value: N
    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.
  • Title: Reason Code
    Maximum Length: 30
    The reason for the cancellation or refund, if the transaction is cancelled. For example, a fee that is inadvertently applied. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Redemption Items
    Title: (Deprecated) Redemption Items
    The redemption items resource is used to retrieve the redemption items that have been updated on transaction processing.
  • Title: Redemption Quantity
    The product quantity that is redeemed in a redemption transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Unit of Measure for the Redemption Quantity
    Maximum Length: 30
    The redemption products quantity unit of measure (UOM) code. For example, possible UOM codes are kilograms or litres. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Refund Basis
    Maximum Length: 30
    The basis for the refund, in the event of cancellation of transaction. The refund options are Prorated, Percentage, or No Refunds. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Refund Percentage
    The percentage of the refund that is granted in the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Refund Override Comments
    Maximum Length: 250
    The refund override comments in the event a refund is made. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Refund Override Reason
    Maximum Length: 30
    The refund override reason code in the event a refund is made. There is no default value, dependency, or limitation associated with this attribute.
  • The social media action name. The accepted values are Check-in, Rate, Share. There is no default value, dependency, or limitation associated with this attribute.
  • The name corresponding to the source code. The accepted values are Web, Mobile, or Billing. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Start Date
    The transaction start date. Either Oracle Loyalty Cloud generates this attribute value when a new transaction is created and populates the attribute with the current date, or it is provided as input from the user when creating transaction using the resource. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Status Code
    Maximum Length: 30
    Default Value: ORA_TXN_STAT_IN_PROG
    The transaction status code values returned from look type ORA_LOY_TXN_STATUS. The default value is ORA_TXN_STAT_IN_PROG.
  • Title: Submit Date
    The transaction submission date. Oracle Loyalty Cloud assigns this attribute value when the transaction is submitted for approval by changing the Transaction Status attribute value to Submitted. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Submit to ID
    The submit to identifier contains the details of the partner reviewer that approves the transaction. This attribute is input by the user. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Subtype Name
    The transaction subtype name. This attribute is dependent on the TypeCodeName attribute. The accepted values are, A. if Accrual??? Product, Manual Credit, or B. if Redemption ??? Product, or Manual Debit. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Tax Amount
    The amount of tax that must be paid for the completed transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Ticket Number
    Maximum Length: 30
    The unique number that is used to identify the ticket booking for an airline transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Recipient Membership Number
    Maximum Length: 30
    The unique identification number of the member to whom points are transferred. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Total Days
    The total days that are required for travel between the source and destination locations. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Total Lines
    The total line items for the transaction. A transaction can include many order line items. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transaction Date
    The date when the transaction is completed. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transaction Number
    Maximum Length: 30
    The transaction number. This is an alternate key that is mandatory during an update. This attribute is automatically generated by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transaction Source Code
    Maximum Length: 30
    The transaction source code attribute indicates the transaction activity type like Airlines, Hotels, Car Rental, and so on. There is no default value, dependency, or limitation associated with this attribute.
  • The name of the transaction status code. The accepted values are In Progress, Processed, or Rejected. There is no default value, dependency, or limitation associated with this attribute.
  • The name of the transaction substatus code. The accepted values are Success, No Promotions Qualified, Insufficient Member Balance, Insufficient Point Blocks. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Transaction Vouchers
    Title: (Deprecated) Transaction Vouchers
    The transaction vouchers resource is used to retrieve the details of loyalty vouchers that are applied to the transaction.
  • Title: Transfer Member
    The unique identification number of the member from whom points are transferred. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transfer Transaction ID
    The unique identification number of the transaction that is during transfer points. There is no default value, dependency, or limitation associated with this attribute.
  • The travel class name that indicates the class of travel. The accepted values are Business, Economy. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Travel Distance
    The transaction travel distance. This attribute stores the total miles travelled. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Point Type Code Name
    The transaction type code name. The accepted values are Accrual or Redemption. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Unaccounted Minor
    Maximum Length: 1
    Default Value: N
    The unaccounted transaction for a minor, that is below the age of majority. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Value Status Code
    Maximum Length: 30
    The status of the validation performed on the record. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Voucher Quantity
    The quantity of vouchers that are assigned because of the given transaction after processing. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : (Deprecated) Accrual Items
Type: array
Title: (Deprecated) Accrual Items
The accrual items resource is used to retrieve the accrual items that have been updated on transaction processing.
Show Source
Nested Schema : (Deprecated) Loyalty Promotions
Type: array
Title: (Deprecated) Loyalty Promotions
The loyalty promotions resource is used to retrieve the details of a loyalty promotion that is applied to the transaction.
Show Source
Nested Schema : (Deprecated) Redemption Items
Type: array
Title: (Deprecated) Redemption Items
The redemption items resource is used to retrieve the redemption items that have been updated on transaction processing.
Show Source
Nested Schema : (Deprecated) Transaction Vouchers
Type: array
Title: (Deprecated) Transaction Vouchers
The transaction vouchers resource is used to retrieve the details of loyalty vouchers that are applied to the transaction.
Show Source
Nested Schema : loyaltyTransactions-AccrualItems-item-response
Type: object
Show Source
  • Title: Number of Points
    The number of accrued points. This attribute gets updated whenever the transaction creates accrual items and assigns points during transaction processing. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Active
    Read Only: true
    Maximum Length: 1
    The accrual item active flag. This attribute is a boolean flag which indicates whether the accrual item is active or not. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Amount
    Read Only: true
    The currency value amount of the transaction from transactions. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Expiration Date
    The date when the points accrued expire. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • The primary key of loyalty accrual Items. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The primary key of the promotion attributes definition. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The primary key value of the promotion from loyalty promotions. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Loyalty Transaction ID
    Read Only: true
    The primary key value of the transaction from transactions. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Base Points
    Read Only: true
    The number of points that have been accrued as a result of accrual type transactions being processed. There is no default value, dependency, or limitation associated with this attribute.
  • The accrual item version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Point Type ID
    Read Only: true
    The identifier of the point type, which is a primary key of the loyaltyPoints attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 30
    The name of the point type for which the accrual Item is created during transaction processing. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Product ID
    Read Only: true
    The foreign key of loyalty products. Oracle Loyalty Cloud set this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Product ID
    Read Only: true
    The foreign key of the program. Oracle Loyalty Cloud set this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The name of the program in which the transaction is created. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Promotion ID
    The foreign key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Name
    Read Only: true
    Maximum Length: 50
    The name of the promotion that has been applied and for which the accrual items are created during transaction processing. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Status Code
    Maximum Length: 30
    The code that represents the status of the accrual item. The accepted values are ORA_LOY_AVAILABLE, ORA_LOY_CANCELLED or ORA_LOY_EXPIRED. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transaction ID
    The foreign key for transactions. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Used Value
    The total points used to date from the accrued points. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyaltyTransactions-Promotions-item-response
Type: object
Show Source
  • Title: Active
    Read Only: true
    Maximum Length: 1
    The boolean attribute that identifies whether the promotion is currently active or not. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Title: Loyalty Milestone ID
    The primary key to identify a loyalty bucket transaction. Oracle Loyalty Cloud generates this attribute value when a bucket is created based on the promotion setup. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The primary key for the promotion bucket transaction identifier. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The foreign key of the program. Oracle Loyalty Cloud set this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The 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.
  • Title: Name
    Read Only: true
    Maximum Length: 50
    The name of the promotion, which can be easily remembered by the user. There is no default value, dependency, or limitation associated with this attribute.
  • The promotion version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • (Deprecated) Promotion Attributes
    Title: (Deprecated) Promotion Attributes
    The promotion attributes resource is used to retrieve the details of a promotion attribute that is updated for transaction.
  • Title: Status Code
    Maximum Length: 30
    The promotion status code that represents the status of the promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The primary key for the transaction. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : (Deprecated) Promotion Attributes
Type: array
Title: (Deprecated) Promotion Attributes
The promotion attributes resource is used to retrieve the details of a promotion attribute that is updated for transaction.
Show Source
Nested Schema : loyaltyTransactions-Promotions-PromotionAttributes-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 1
    The 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.
  • The attribute definition identifier that results from transaction processing. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 30
    The 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.
  • Read Only: true
    Maximum Length: 30
    The display name that is displayed to the user. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Read Only: true
    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.
  • The primary key of loyalty attribute items. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 30
    The 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.
  • The promotion attribute bucket identifier. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • The 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.
  • 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.
  • Maximum Length: 250
    The value of the promotion or program attribute item. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyaltyTransactions-RedemptionItems-item-response
Type: object
Show Source
  • Title: Accrual Item ID
    The redemption item accrual item identifier. This attribute reflects the accrual item identifier, from which the points are redeemed. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Amount
    Read Only: true
    The 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.
  • Read Only: true
    Maximum Length: 30
    The 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
  • Read Only: true
    The redemption item attribute definition bid. This attribute 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.
  • Read Only: true
    The primary key from loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Loyalty Redemption Item ID
    The primary key of loyalty redemption items. The redemption items are created when a transaction that is of type Redemption is processed successfully resulting in redeeming accrued points. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Loyalty Transaction ID
    Read Only: true
    The primary key from transactions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 30
    The 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.
  • Title: Object Version Number
    The redemption item version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Point Type ID
    Read Only: true
    The identifier of point type which is a primary key of the loyaltyPoints attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Process Date
    The date when the transaction that resulted in the creation of the redemption is processed. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Product ID
    Read Only: true
    The foreign key for the program. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The name of the program under which the transaction is created. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Name
    Read Only: true
    Maximum Length: 50
    The accrual item active flag. This attribute is a boolean flag which indicates whether the accrual item is active or not. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 30
    The 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.
  • Title: Transaction ID
    The primary key from transactions which is a foreign key for redemption items. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Type Code
    Maximum Length: 30
    The 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.
  • Title: Redemption Item Value
    The value of redemption items that are redeemed. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyaltyTransactions-TransactionVouchers-item-response
Type: object
Show Source
  • Title: Currency Amount
    Read Only: true
    The currency value of the voucher if the DiscountType attribute is set to Absolute Value. This value is provided by the user when creating a voucher and is required if the voucher is of type Absolute Value. This attribute depends up on the DiscountType attribute setting. There is no default value or limitation associated with this attribute.
  • Title: Discount Percentage
    Read Only: true
    The voucher discount percent. This attribute is required if the Discount Type attribute is set to Percentage. This attribute depends on the DiscountType attribute setting which is an input value from the user when creating a voucher. There is no default value or limitation associated with this attribute.
  • Title: Expiration Date
    Read Only: true
    The expiration date of the voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or it 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.
  • Title: Inventory Organization ID
    Read Only: true
    The unique identifier of the organization that provides the inventory when the user is redeeming the vouchers. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Title: Member Voucher ID
    Read Only: true
    The 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.
  • Title: Member ID
    Read Only: true
    The primary key of the member to whom the voucher is assigned. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The identity of the product for an existing voucher. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Quantity
    Read Only: true
    The quantity of vouchers that are assigned to a member. The value for this attribute must be a positive integer. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Transaction ID
    Read Only: true
    The primary key from the transaction. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Used Date
    Read Only: true
    The attribute is a date value that is assigned when the voucher status is changed from Available to Used through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Voucher Effective Start Date
    Read Only: true
    The date when the voucher is in effect. This date is 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.
  • Read Only: true
    The voucher assignment based on the transaction type. It is set to Accrual for accrual transactions or Redemption for redemption transactions. This is an input value provided by a user when creating a voucher. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The voucher status. The accepted values are Available, Expired, or Used. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The loyalty product description for the voucher. Oracle Loyalty Cloud assigns the ProductId 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.
Back to Top