Jump to

• Request
• Response

Get a loyalty redemption item updated during transaction processing (Deprecated)

get

/crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/RedemptionItems/{RedemptionItemsUniqID}

Request

Path Parameters

• 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.
• RedemptionItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LoyRdmItmId and LoyAttrdefnBId ---for the (Deprecated) Redemption Items resource and used to uniquely identify an instance of (Deprecated) Redemption Items. The client should not generate the hash key value. Instead, the client should query on the (Deprecated) Redemption Items collection resource with a filter on the primary key values in order to navigate to a specific instance of (Deprecated) Redemption Items.
  
  For example: RedemptionItems?q=LoyRdmItmId=<value1>;LoyAttrdefnBId=<value2>

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 Top

Response

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.

Body ()

Root Schema : loyaltyTransactions-RedemptionItems-item-response

Type: object

Show Source

• AccrualItemId: integer (int64)
  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.
• AmountValue: number
  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.
• DisplayName: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyAttrdefnBId: integer (int64)
  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.
• LoyPromoId: integer (int64)
  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.
• LoyRdmItmId: integer (int64)
  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.
• LoyTransactionId: integer (int64)
  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.
• ObjectCode: string
  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.
• ObjectVersionNumber: integer (int32)
  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.
• PointTypeId: integer (int64)
  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.
• ProcessDt: string (date-time)
  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.
• ProgId: integer (int64)
  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.
• ProgramName: string
  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.
• PromotionName: string
  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.
• PromotionTypeCode: string
  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.
• TransactionId: integer (int64)
  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.
• TypeCode: string
  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.
• Value: number
  Title: Redemption Item Value

  The value of redemption items that are redeemed. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "TypeCode":{
            "title":"Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LoyPromoId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccrualItemId":{
            "title":"Accrual Item ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgId":{
            "title":"Product ID",
            "type":"integer",
            "description":"The foreign key for the program. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AmountValue":{
            "title":"Amount",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The name of the program under which the transaction is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessDt":{
            "title":"Process Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PointTypeId":{
            "title":"Point Type ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PromotionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The redemption item version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DisplayName":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyRdmItmId":{
            "title":"Loyalty Redemption Item ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Value":{
            "title":"Redemption Item Value",
            "type":"number",
            "description":"The value of redemption items that are redeemed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LoyTransactionId":{
            "title":"Loyalty Transaction ID",
            "type":"integer",
            "description":"The primary key from transactions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top