Get all loyalty products (Deprecated)
get
/crmRestApi/resources/11.13.18.05/loyaltyProducts
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a redemption product with a specified product name.
Finder Variables: - redemptionProductsFinder: Finds a redemption product with a specified member number, point type name, partner party number,
product item number, loyalty program name and date on which the transaction takes place.
Finder Variables:- ItemNumber; string; The loyalty product item number.
- MemberNumber; string; The loyalty member number.
- PartyNumber; string; The loyalty partner party number.
- PointTypeName; string; The loyalty point type name.
- ProgramName; string; The loyalty program name.
- TransactionDate; string; The date on which the transaction takes place.
- PrimaryKey: Finds a redemption product with a specified product name.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- InternalName; string; The internal name of the loyalty point type. There is no default value, dependency, or limitation associated with this attribute.
- ItemNumber; string; The item number of the product. This is the product number for which Oracle Loyalty Cloud shows the redemption points. There is no default value, dependency, or limitation associated with this attribute.
- MemberPointBalance; number; The loyalty member's point balance for a given point type. This value shows Member Check Credit functionality when The MemberNumber parameter is provided for the redemptionProductsFinder finder to show both the redemption points for each product and the point balance for the member as a credit check feature. There is no default value, dependency, or limitation associated with this attribute.
- PartyName; string; The party name of the loyalty partner. This information shows the name of partner for a given partner party number. There is no default value or dependency associated with this attribute.
- PartyNumber; string; The party number of the loyalty partner. This attribute is also a parameter in the redemptionProductsFinder finder. There is no default value or dependency associated with this attribute.
- PointTypeName; string; The name of the point type. This is also a parameter in redemptionProductsFinder finder. If the value not provided, the finder lists the ProdRedemptionPoint attribute value for all possible point types in a given program name. There is no default value, dependency, or limitation associated with this attribute.
- ProdRedempEndDt; string; The end date for product redemption, that is, the date when the redemption product is no longer in effect. This date is the value of the TransactionDate parameter returned by the redemptionProductsFinder finder search in between the ProdRedempStartDt and ProdProdRedempEndDt attributes. There is no default value, dependency, or limitation associated with this attribute.
- ProdRedempStartDt; string; The start date for product redemption, that is, the date when the redemption product comes into effect. This date is the value of the TransactionDate parameter returned by the redemptionProductsFinder finder search in between the ProdRedempStartDt and ProdProdRedempEndDt attributes. There is no default value, dependency, or limitation associated with this attribute.
- ProdRedemptionPoint; integer; The points required to redeem the product. Each product requires a point value that indicates the points required when a member redeems the product. There is no default value, dependency, or limitation associated with this attribute.
- ProductName; string; The product name. This name describes the product for a given ItemNumber filter parameter when using the redemptionProductsFinder finder. Oracle Loyalty Cloud shows the product for the ProdRedemptionPoint value. There is no default value, dependency, or limitation associated with this attribute.
- ProgramName; string; The program name, This attribute is also a parameter in redemptionProductsFinder finder. There is no default value, dependency, or limitation associated with this attribute.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : loyaltyProducts
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyaltyProducts-item-response
Type:
Show Source
object
-
InternalName: string
Read Only:
true
Maximum Length:75
The internal name of the loyalty point type. There is no default value, dependency, or limitation associated with this attribute. -
ItemNumber: string
Read Only:
true
Maximum Length:300
The item number of the product. This is the product number for which Oracle Loyalty Cloud shows the redemption points. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberPointBalance: number
The loyalty member's point balance for a given point type. This value shows Member Check Credit functionality when The MemberNumber parameter is provided for the redemptionProductsFinder finder to show both the redemption points for each product and the point balance for the member as a credit check feature. There is no default value, dependency, or limitation associated with this attribute.
-
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The party name of the loyalty partner. This information shows the name of partner for a given partner party number. There is no default value or dependency associated with this attribute. -
PartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The party number of the loyalty partner. This attribute is also a parameter in the redemptionProductsFinder finder. There is no default value or dependency associated with this attribute. -
PointTypeName: string
Read Only:
true
Maximum Length:30
The name of the point type. This is also a parameter in redemptionProductsFinder finder. If the value not provided, the finder lists the ProdRedemptionPoint attribute value for all possible point types in a given program name. There is no default value, dependency, or limitation associated with this attribute. -
ProdRedempEndDt: string
(date)
Read Only:
true
The end date for product redemption, that is, the date when the redemption product is no longer in effect. This date is the value of the TransactionDate parameter returned by the redemptionProductsFinder finder search in between the ProdRedempStartDt and ProdProdRedempEndDt attributes. There is no default value, dependency, or limitation associated with this attribute. -
ProdRedempStartDt: string
(date)
Read Only:
true
The start date for product redemption, that is, the date when the redemption product comes into effect. This date is the value of the TransactionDate parameter returned by the redemptionProductsFinder finder search in between the ProdRedempStartDt and ProdProdRedempEndDt attributes. There is no default value, dependency, or limitation associated with this attribute. -
ProdRedemptionPoint: integer
(int32)
Read Only:
true
The points required to redeem the product. Each product requires a point value that indicates the points required when a member redeems the product. There is no default value, dependency, or limitation associated with this attribute. -
ProductName: string
Read Only:
true
Maximum Length:240
The product name. This name describes the product for a given ItemNumber filter parameter when using the redemptionProductsFinder finder. Oracle Loyalty Cloud shows the product for the ProdRedemptionPoint value. There is no default value, dependency, or limitation associated with this attribute. -
ProgramName: string
Title:
Program
Read Only:true
Maximum Length:50
The program name, This attribute is also a parameter in redemptionProductsFinder finder. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example shows how to retrieve a catalog of product redemptions. The example uses a finder for redemption products for the High Miles loyalty program with a transaction date of 2016-12-13 and point type set to Miles.
Use GET with the following URI syntax to redeem the catalog of product redemptions:
https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts?finder=redemptionProductsFinder;ProgramName=High Miles,TransactionDate=2016-12-13T06:43:52+00:00,PointTypeName=Miles
Example of Response Header
Cache-Control -no-cache, no-store, must-revalidate
Connection -keep-alive
Content-Encoding -gzip
Content-Language -en
Content-Length -742
Content-Type -application/vnd.oracle.adf.resourcecollection+json
Date -Fri, 23 Dec 2016 16:56:23 GMT
Link -<https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts>;rel="self";kind="collection";name="loyaltyProducts"
Location -
REST-Framework-Version -1
Server -Oracle-HTTP-Server-11g
Vary -Accept-Encoding
X-ORACLE-DMS-ECID -005H32ZoyIx5Qdv_GXl3if0002Es0007^G
Example of Response Body
{
"items" : [ {
"ProdRedempEndDt" : null,
"ProdRedempStartDt" : "2016-05-01",
"ProdRedemptionPoint" : 20000,
"ProgramName" : "High Miles",
"PointTypeName" : "Miles",
"InternalName" : "PointTypeAVal",
"ItemNumber" : "sku639502",
"PartyNumber" : "36013",
"PartyName" : "Heritage Group of Hotels",
"MemberPointBalance" : null,
"ProductName" : "Free Stay of 1 Night in Heritage Hotel Voucher",
"links" : [ {
"rel" : "self",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts/00060000000...93552BD78",
"name" : "loyaltyProducts",
"kind" : "item"
}, {
"rel" : "canonical",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts/00060000000...93552BD78",
"name" : "loyaltyProducts",
"kind" : "item"
} ]
}, {
"ProdRedempEndDt" : null,
"ProdRedempStartDt" : "2016-05-01",
"ProdRedemptionPoint" : 1000,
"ProgramName" : "High Miles",
"PointTypeName" : "Miles",
"InternalName" : "PointTypeAVal",
"ItemNumber" : "sku639508",
"PartyNumber" : "36011",
"PartyName" : "Savvari Fleet Service",
"MemberPointBalance" : null,
"ProductName" : "Free Ride with Savvari Fleet Voucher",
"links" : [ {
"rel" : "self",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts/00060000000...93552BD65",
"name" : "loyaltyProducts",
"kind" : "item"
}, {
"rel" : "canonical",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts/00060000000...93552BD65",
"name" : "loyaltyProducts",
"kind" : "item"
} ]
}, {
"ProdRedempEndDt" : null,
"ProdRedempStartDt" : "2016-05-01",
"ProdRedemptionPoint" : 2500,
"ProgramName" : "High Miles",
"PointTypeName" : "Miles",
"InternalName" : "PointTypeAVal",
"ItemNumber" : "sku639503",
"PartyNumber" : null,
"PartyName" : null,
"MemberPointBalance" : null,
"ProductName" : "Economy to Business Class Upgrade",
"links" : [ {
"rel" : "self",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts/00060000000...FFFFFFFFF",
"name" : "loyaltyProducts",
"kind" : "item"
}, {
"rel" : "canonical",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts/00060000000...FFFFFFFFF",
"name" : "loyaltyProducts",
"kind" : "item"
} ]
}, {
"ProdRedempEndDt" : null,
"ProdRedempStartDt" : "2016-05-01",
"ProdRedemptionPoint" : 5000,
"ProgramName" : "High Miles",
"PointTypeName" : "Miles",
"InternalName" : "PointTypeAVal",
"ItemNumber" : "sku639504",
"PartyNumber" : null,
"PartyName" : null,
"MemberPointBalance" : null,
"ProductName" : "Extra Baggage Voucher",
"links" : [ {
"rel" : "self",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts/00060000000...FFFFFFFFF",
"name" : "loyaltyProducts",
"kind" : "item"
}, {
"rel" : "canonical",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts/00060000000...FFFFFFFFF",
"name" : "loyaltyProducts",
"kind" : "item"
} ]
}, {
"ProdRedempEndDt" : null,
"ProdRedempStartDt" : "2016-05-01",
"ProdRedemptionPoint" : 10000,
"ProgramName" : "High Miles",
"PointTypeName" : "Miles",
"InternalName" : "PointTypeAVal",
"ItemNumber" : "sku639501",
"PartyNumber" : null,
"PartyName" : null,
"MemberPointBalance" : null,
"ProductName" : "Flight",
"links" : [ {
"rel" : "self",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts/00060000000...FFFFFFFFF",
"name" : "loyaltyProducts",
"kind" : "item"
}, {
"rel" : "canonical",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts/00060000000...FFFFFFFFF",
"name" : "loyaltyProducts",
"kind" : "item"
} ]
}, {
"ProdRedempEndDt" : null,
"ProdRedempStartDt" : "2016-05-01",
"ProdRedemptionPoint" : 5500,
"ProgramName" : "High Miles",
"PointTypeName" : "Miles",
"InternalName" : "PointTypeAVal",
"ItemNumber" : "sku639505",
"PartyNumber" : null,
"PartyName" : null,
"MemberPointBalance" : null,
"ProductName" : "Free Lounge Service Voucher",
"links" : [ {
"rel" : "self",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts/00060000000...FFFFFFFFF",
"name" : "loyaltyProducts",
"kind" : "item"
}, {
"rel" : "canonical",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts/00060000000...FFFFFFFFF",
"name" : "loyaltyProducts",
"kind" : "item"
} ]
} ],
"count" : 6,
"hasMore" : false,
"limit" : 25,
"offset" : 0,
"links" : [ {
"rel" : "self",
"href" : "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyProducts",
"name" : "loyaltyProducts",
"kind" : "collection"
} ]
}