Get a redemption product
get
/crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/RedemptionProducts/{RedemptionProductsUniqID}
Request
Path Parameters
-
LoyProgramId(required): integer(int64)
The primary key to identify a program. Oracle Loyalty Cloud generates this attribute value during the creation of a program record. There is no default value, dependency, or limitation associated with this attribute.
-
RedemptionProductsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Redemption Products resource and used to uniquely identify an instance of Redemption Products. The client should not generate the hash key value. Instead, the client should query on the Redemption Products collection resource in order to navigate to a specific instance of Redemption Products to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : loyPrograms-RedemptionProducts-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The loyalty user that created the redemption product. Oracle Loyalty Cloud generates this attribute value during the creation of a new redemption product record. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the redemption product is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new redemption product record. There is no default value, dependency, or limitation associated with this attribute. -
InternalName: string
Title:
Internal Name
Read Only:true
Maximum Length:75
The redemption product internal name. The identifier internal name values come from the loyalty attributes definitions. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute. -
ItemNumber: string
Title:
Product Number
Read Only:true
Maximum Length:300
The item number of the loyalty product. This is the product number for which the redemption points are shown. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the redemption product record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the redemption product record occur. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user that last updated the redemption product. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes occur to the redemption product. There is no dependency or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberPointBalance: number
The member's point balance for a given point type. This value shows the Member Check Credit functionality when the MemberNumber parameter is used in the redemptionProductsFinder finder to find the redemption points for each product, and also shows the point balance of the member as a credit check.
-
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 PartyNumber. There is no default value, dependency, or limitation associated with this attribute. -
PartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The party number of the loyalty partner. PartyNumber is also a parameter in the redemptionProductsFinder finder. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeName: string
Title:
Point Type Name
The name of the point type. This is also a parameter in the redemptionProductsFinder finder. If the value not provided, this attribute lists ProdRedemptionPoint for all possible point types in a given ProgramName. There is no default value or limitation associated with this attribute. -
ProdRedempComments: string
Title:
Comments
Maximum Length:1000
The text field indicates the comments added by the loyalty administrator in a redemption product record. There is no default value, dependency, or limitation associated with this attribute. -
ProdRedempEndDt: string
(date)
Title:
End Date
The end date for the loyalty product redemption. It is the TransactionDate parameter in the redemptionProductsFinder finder search in between ProdRedempStartDt and ProdProdRedempEndDt. There is no default value, dependency, or limitation associated with this attribute. -
ProdRedempStartDt: string
(date)
Title:
Start Date
The start date for loyalty product redemption. This is the starting date when the Redemption Product is effective. It is the TransactionDate parameter in redemptionProductsFinder finder search in between ProdRedempStartDt and ProdProdRedempEndDt. There is no default value, dependency, or limitation associated with this attribute. -
ProdRedemptionPoint: integer
(int32)
Title:
Points
The points required to redeem the loyalty product. Each product requires some point value which indicates the points required while redeeming the product. There is no default value, dependency, or limitation associated with this attribute. -
ProdRedempURL: string
Title:
Product Redemption URL
Maximum Length:1000
The text field indicates the redemption URL for a product which is enabled for redemption. There is no default value, dependency, or limitation associated with this attribute. -
ProductName: string
Title:
Product
The loyalty product name. This attribute describes the product for a given ItemNumber filter parameter in the redemptionProductsFinder finder and is the product for which the ProdRedemptionPoint value is shown. -
ProgramName: string
Title:
Program
Read Only:true
Maximum Length:50
The program for which the promotion is created. 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.
Links
- ItemPVO1
-
Operation: /crmRestApi/resources/11.13.18.05/productsParameters:
- finder:
ProductList%3BBind_UsageCode%3DLOYALTY%2CBind_UsageModeCode%3DLOY
The product resource is used to view, create, or modify a product. A product is an item that an organization or company intends to sell. - finder: