Get a loyalty promotion applied to a transaction (Deprecated)
get
/crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/Promotions/{LoyPromoId}
Request
Path Parameters
-
LoyPromoId(required): integer(int64)
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.
-
LoyTransactionId(required): integer(int64)
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.
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 : loyaltyTransactions-Promotions-item-response
Type:
Show Source
object
-
Active: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyBucketId: integer
(int64)
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. -
LoyBucketTransactionId: integer
(int64)
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. -
LoyProgId: integer
(int64)
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. -
LoyPromoId: integer
(int64)
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. -
Name: string
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. -
ObjectVersionNumber: integer
(int32)
The promotion version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
-
PromotionAttributes: array
(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. -
StatusCode: string
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. -
TransactionId: integer
(int64)
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 : 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.
Nested Schema : loyaltyTransactions-Promotions-PromotionAttributes-item-response
Type:
Show Source
object
-
Active: string
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. -
AttribDefnId: integer
(int64)
The attribute definition identifier that results from transaction processing. There is no default value, dependency, or limitation associated with this attribute.
-
AttrTypeCode: string
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. -
DisplayName: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyAttrdefnBId: integer
(int64)
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. -
LoyAttrItmId: integer
(int64)
The primary key of loyalty attribute items. There is no default value, dependency, or limitation associated with this attribute.
-
ObjectCode: string
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. -
PromoBucketId: integer
(int64)
The promotion attribute bucket identifier. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
-
PromoId: integer
(int64)
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.
-
TransactionId: integer
(int64)
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.
-
Value: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PromotionAttributes
-
Parameters:
- LoyPromoId:
$request.path.LoyPromoId
- LoyTransactionId:
$request.path.LoyTransactionId
The promotion attributes resource is used to retrieve the details of a promotion attribute that is updated for transaction. - LoyPromoId: