Jump to

• Request
• Response

Get a loyalty redemption item updated during transaction processing

get

/crmRestApi/resources/11.13.18.05/loyTransactions/{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 for the Redemption Items resource and used to uniquely identify an instance of Redemption Items. The client should not generate the hash key value. Instead, the client should query on the Redemption Items collection resource in order to navigate to a specific instance of Redemption Items 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 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 : loyTransactions-RedemptionItems-item-response

Type: object

Show Source

• AccrualItemNumber: string
  Title: Accrual Item Number

  Maximum Length: 30

  An alternate key that uniquely identifies an accrual item that is used in redemption. There is no default value, dependency, or limitation associated with this attribute.
• ActionNote: string
  Title: Action Note

  Maximum Length: 1000

  The attribute indicates additional information pertaining to redemption action because of which the redemption item was created. There is no default value 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.
• Comments: string
  Title: Comments

  Maximum Length: 250

  The comments entered by user, if any, for future reference. There is no default value, dependency, or limitation associated with this attribute.
• DisplayName: string
  Title: Point Type

  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.
• LoyRdmItmId: integer (int64)
  Title: Loyalty Redemption Item ID

  The attribute redemption item identifier is the primary key of redemption items. 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.
• MemberNumber: string
  Title: Member Number

  Read Only: true

  Maximum Length: 30

  The member for whom the redemption item is created. There is no default value, dependency, or limitation associated with this attribute.
• ObjectCode: string
  Title: Object Code

  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.
• ProcessDate: string (date-time)
  Title: Process Date

  Read Only: true

  The transaction process date. This attribute specifies the day on which the created transaction is processed that resulted in the creation of the redemption items. 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
  Title: Program

  Read Only: true

  Maximum Length: 50

  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: Promotion

  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.
• PromotionNumber: string
  Title: Promotion Number

  Maximum Length: 30

  The promotion number that has been applied to the redemption transaction. There is no default value, dependency, or limitation associated with this attribute.
• PromotionType: string
  Title: Promotion Type Meaning

  Read Only: true

  Maximum Length: 80

  The attribute represents the list of values meaning for the Promotion type code. The value represents the promotion type. The accepted values are: Accrual, Redemption or Tier. There is no default value, dependency, or limitation associated with this attribute.
• PromotionTypeCode: string
  Title: Type

  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.
• RedemptionItemNumber: string
  Title: Item Number

  Maximum Length: 30

  The attribute redemption item number is an alternate key that uniquely identifies a redemption item. There is no default value, dependency, or limitation associated with this attribute.
• TransactionnNumber: string
  Title: Transaction Number

  Read Only: true

  Maximum Length: 30

  This attribute indicates the transaction number which uniquely identifies the loyalty transaction. This attribute is automatically generated by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.
• TransactionNumber: string
  Title: Transaction Number

  Maximum Length: 30

  The transaction number that uniquely identifies the loyalty transaction. This attribute value is automatically generated. There is no default value, dependency, or limitation associated with this attribute.
• Type: string
  Title: Type Meaning

  Read Only: true

  Maximum Length: 80

  The attribute represents the list of values meaning for Redemption item type code. The accepted values are: Cancelled Points, Points Redeemed, and so on. 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: Number of Points

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

{
    "type":"object",
    "properties":{
        "PromotionType":{
            "title":"Promotion Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The attribute represents the list of values meaning for the Promotion type code. The value represents the promotion type. The accepted values are: Accrual, Redemption or Tier. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionNumber":{
            "title":"Transaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The transaction number that uniquely identifies the loyalty transaction. This attribute value is automatically generated. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "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
        },
        "RedemptionItemNumber":{
            "title":"Item Number",
            "maxLength":30,
            "type":"string",
            "description":"The attribute redemption item number is an alternate key that uniquely identifies a redemption item. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":250,
            "type":"string",
            "description":"The comments entered by user, if any, for future reference. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessDate":{
            "title":"Process Date",
            "type":"string",
            "description":"The transaction process date. This attribute specifies the day on which the created transaction is processed that resulted in the creation of the redemption items. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "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":{
            "title":"Object Code",
            "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":{
            "title":"Program",
            "maxLength":50,
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccrualItemNumber":{
            "title":"Accrual Item Number",
            "maxLength":30,
            "type":"string",
            "description":"An alternate key that uniquely identifies an accrual item that is used in redemption. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "PromotionTypeCode":{
            "title":"Type",
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionName":{
            "title":"Promotion",
            "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
        },
        "Type":{
            "title":"Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The attribute represents the list of values meaning for Redemption item type code. The accepted values are: Cancelled Points, Points Redeemed, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionNumber":{
            "title":"Promotion Number",
            "maxLength":30,
            "type":"string",
            "description":"The promotion number that has been applied to the redemption transaction. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "MemberNumber":{
            "title":"Member Number",
            "maxLength":30,
            "type":"string",
            "description":"The member for whom the redemption item is created. 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 attribute redemption item identifier is the primary key of redemption items. 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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Value":{
            "title":"Number of Points",
            "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
        },
        "DisplayName":{
            "title":"Point Type",
            "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,
            "x-queryable":true
        },
        "ActionNote":{
            "title":"Action Note",
            "maxLength":1000,
            "type":"string",
            "description":"The attribute indicates additional information pertaining to redemption action because of which the redemption item was created. There is no default value 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"
            }
        },
        "TransactionnNumber":{
            "title":"Transaction Number",
            "maxLength":30,
            "type":"string",
            "description":"This attribute indicates the transaction number which uniquely identifies the loyalty transaction. This attribute is automatically generated by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "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