Change History

Review what's new in this document.

January 2023

The following table lists the documentation introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and improved to increase usability.

October 2022

The following table lists the documentation introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and improved to increase usability.

July 2022

The following table lists the documentation introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and improved to increase usability.

April 2022

The following table lists the documentation introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and improved to increase usability.

January 2022

The following table lists the documentation introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and improved to increase usability.

October 2021

The following table lists the documentation introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and improved to increase usability.

July 2021

The following table lists the documentation introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and improved to increase usability.

April 2021

The following table lists the documentation introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and improved to increase usability.

January 2021

The following table lists the documentation introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and improved to increase usability.

October 2020

The following table lists the documentation introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and improved to increase usability.
Get Started section Updates to topics
  • Updated the Status Codes topic with new status codes: 501 Not Implemented and 504 Gateway Timeout.
  • Updated the Perform Batch Actions topic with information about using batch requests on custom actions.
  • Updated the Manage Collections and the Access Metadata topics with information about identifying queryable attributes

May 2020

The following table lists the documentation introduced in this version of the document.

Change Type Description

Display Member Activities

New use case This new use case shows examples of retrieving member activities using the Activities child resource.

Activities

New resource This topic describes the REST end points for the Activities child resource.

April 2020

The following table lists the documentation introduced in this version of the document.

Change Type Description
Minor changes Non technical No new features have been added to this version of the guide.

February 2020

The following table lists the documentation changes introduced in this version of the document.

Change Type Description

Loyalty Member Promotion Enrollments

Loyalty Programs

(Deperecated) Loyalty Members

Updated resources Minor changes have been made to these resources for this release.

REST Resource Types

Updated topic Minor change. References to "Upsert header" have been changed to "Upsert-Mode header".

January 2020

The following table lists the documentation changes introduced in this version of the document.

Change Type Description

Loyalty Members

Loyalty Promotions

Loyalty Transactions

Updated resources Minor changes have been made to these resources for this release.
Quick Start Updated topics Added information about reviewing opt-in requirements.
Set the REST Framework Version Added information about the three new framework versions supported (Version 5, Version 6, and Version 7).
Access Metadata Added information about using the Accept-Language header in a GET request to retrieve details in a preferred language.

November 2019

The following table lists the documentation changes introduced in this version of the document.

Change Type Description

Create and Process a Transfer Points Transaction

New use case This new use case shows you how to create a new transfer points transaction record and process the transaction.

Loyalty Member Promotion Enrollments

Loyalty Products

Loyalty Programs

Updated resources Miscellaneous changes have been made to these resources.

October 2019

The following table lists the documentation changes introduced in this version of the document.

Change Type Description

Loyalty Member Promotion Enrollments

Loyalty Members

Loyalty Products

Loyalty Programs

Loyalty Promotions

Loyalty Transactions

Loyalty Membership Cards

Updated resources New attributes have been added plus other miscellaneous changes have been made in this release.

Create and Process a Queued Transaction

Redeem a Voucher in a Single Step

Update a Loyalty Member

New use cases These use cases show you how to accomplish various tasks with Oracle Loyalty Cloud.

August 2019

The following table lists the documentation changes introduced in this version of the document.

Change Type Description

Perform Batch Actions

New topic This topic shows how you can combine multiple operations into a single HTTP request (batch actions) to improve performance.

Members' merge

Cancel a loyalty transaction

Process a loyalty transaction

Modified topics These topics contain minor updates to the custom action descriptions.

July 2019

The following table lists the documentation changes introduced in this version of the document.

Change Type Description

Loyalty Members

Loyalty Transactions

Updated resources New attributes have been added to these resources.
Loyalty Membership Cards Updated resource The following resource actions have been deprecated:
  • Create membership cards for a member
  • Update a loyalty membership card that is assigned to a member
Lists of Values New topic This topic describes how you can use Lists of Values (LOVs) to retrieve frequently used static data
Required Attributes and Path Parameters for Request Payloads Updated topic This topic has been rewritten for the non-deprecated resources.

Quick Start

Use JSON Web Token for Authorization

Updated topics These topics have been updated to include screen captures of REST API calls using the Postman application.

Create a loyalty member

Create a loyalty transaction

Cancel a loyalty transaction

Delete a loyalty transaction

Process a loyalty transaction

New examples These examples show you how to use various Oracle Loyalty Cloud REST API calls.

April 2019

The following table lists the documentation changes introduced in this version of the document.

Change Type Description

Loyalty Members

Loyalty Programs

Updated resources The end points and parameters for these resources have been enhanced.
Merge Multiple Members New use case This use case describes how to merge two loyalty members into a surviving member.
Use JSON Web Token for Authorization New topic This topic describes how to use JSON Web Token (JWT) for authorization in REST applications.
Supported HTTP Methods Changed topic This topic has been rewritten.
Get Started section Changed topics Minor updates have been made throughout.

January 2019

The following table lists the documentation changes introduced in this version of the document.

Change Type Description
Use Cases New use cases Three new use cases have been added:
Update the Deprecated Endpoints and Attributes New topic This topic describes the updates required to the deprecated end points and attributes to update them to be current.

November 2018

The following table lists the documentation changes introduced in this version of the document.

Change Type Description
Required Attributes and Path Parameters for Request Payloads New topic This topic consolidates the required attributes and path parameters for the supported Oracle Loyalty Cloud APIs, including deprecated APIs, into one topic.

Manage Collections

Set the REST Framework Version

Supported HTTP Methods

Modified topics These topics have been updated to provide examples that are specific to Oracle Loyalty Cloud.

October 2018

The following table lists the documentation changes introduced in this version of the document.

Change Type Description
Get Started section Updates to topics The topics in this section have been revised and reorganized to increase usability.
Deprecated Paths and Endpoints New topic This topic provides important information on APIs that have been deprecated in this release.
Required Attributes and Path Parameters for Request Payloads New topic This topic describes the recommended Oracle Loyalty Cloud APIs supported in this release.

Loyalty Member Promotion Enrollments

Loyalty Members

Loyalty Products

Loyalty Programs

Loyalty Promotions

Loyalty Transactions

Loyalty Vouchers

New resources These topics describe the REST end points for the new Oracle Loyalty Cloud resources.

June 2018

The following table lists documentation changes introduced in this version of the document.

Change Type Description
Tasks section Updated Attributes The resource attribute descriptions have been enhanced to provide additional usage details, including items such as default values, dependencies, and limits.

May 2018

The following table lists changes introduced in this version of the document.

Change Type Description

Households

New Resource

The household resource is used to view, create, and update a household. Household is a group that has a relationship with either an account or a contact. A household object includes attributes that are used to store values while creating or updating a household.

Delete a loyalty promotion to which a member is enrolled

Get all loyalty promotions to which a member is enrolled

Update a loyalty promotion to which a member is enrolled

Get all loyalty members

Get all loyalty membership cards that are assigned to a member

Update a loyalty membership card that is assigned to a member

Get a loyalty program

Get all loyalty programs

Get a promotion

Get all promotions

Get all loyalty transactions

New Examples

These examples show you how to use various Oracle Loyalty Cloud APIs.

Get Started section

Updated Topics

The topics in this section have been reorganized to increase usability.