Jump to

• Request
• Response

Get a point item for a given loyalty member

get

/crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/pointItems/{pointItemsUniqID}

Request

Path Parameters

• MemberNumber(required): string
  The member number. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute.
• pointItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Point Items resource and used to uniquely identify an instance of Point Items. The client should not generate the hash key value. Instead, the client should query on the Point Items collection resource in order to navigate to a specific instance of Point 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:
  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.

Body ()

Root Schema : loyMembers-pointItems-item-response

Type: object

Show Source

• AccrualedValue: number
  Title: Number of Points

  The points accrued value for the points that are accrued by the member. There is no default value, dependency, or limitation associated with this attribute.
• AccrualEffDt: string (date-time)
  Title: Accrual Start Date

  Displays the date from which the points would be effective, that is, the date when the points are available for redemption. Point items having a future effective date will fall under the 'Future Points' category and would move under 'Available Points' once the effectivity date is reached. There is no default value, dependency, or limitation associated with this attribute.
• AccrualItemNumber: string
  Title: Item Number

  Maximum Length: 30

  The accrual item number reference which shows accrual information to reach this point balance. There is no default value or limitation associated with this attribute.
• ActionNote: string
  Title: Action Note

  Read Only: true

  Maximum Length: 1000

  The attribute indicates additional information pertaining to an accrual action that resulted in the creation of the accrual item. There is no default value or limitation associated with this attribute.
• Active: string
  Title: Active

  Read Only: true

  Maximum Length: 1

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

  Read Only: true

  The date when the accrual Item is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction. There is no default value, dependency, or limitation associated with this attribute.
• DisplayName: string
  Title: Point Type

  Read Only: true

  Maximum Length: 30

  The name of the point type for which the accrual Item is created during transaction processing. There is no default value, dependency, or limitation associated with this attribute.
• ExpirationDt: string (date-time)
  Title: Expiration Date

  The date when the points that have accrued expire. There is no default value, dependency, or limitation associated with this attribute.
• ExpiredValue: number
  The point items which have expired. 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.
• LoyAcrlItmId: integer (int64)
  Title: Loyalty Accrual Item ID

  The accrual item identifier to identify which accrual item has a specific point balance value. There is no default value or limitation associated with this attribute.
• MemberNumber: string
  The member for whom the accrual item is created. There is no default value, dependency, or limitation associated with this attribute.
• Name: string
  Title: Point Subtype

  Read Only: true

  Maximum Length: 50

  The name of the point type that is accrued by the member. There is no default value, dependency, or limitation associated with this attribute.
• NumberOfPoints: number
  Title: Number Points

  Read Only: true

  The number of points that have been accrued as a result of accrual type transactions being processed. There is no default value, dependency, or limitation associated with this attribute.
• OrderNumber: string
  Maximum Length: 30

  The number associated with an order. This attribute is used by Oracle Loyalty Cloud when consolidating transactions. There is no default value, dependency, or limitation associated with this attribute.
• PointBlkId: integer (int64)
  Title: Point Block ID

  The attribute indicates the primary key of the point block from which the accrued points are allocated to the member. There is no default value, dependency, or limitation associated with this attribute.
• ProcessDt: string (date-time)
  Title: Processed Date

  The transaction process date. This attribute specifies the day on which the created transaction is processed that resulted in the creation of accrual items. There is no default value, dependency, or limitation associated with this attribute.
• ProdId: integer (int64)
  Title: Product ID

  Read Only: true

  The foreign key of loyalty products. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
• ProductNumber: string
  Read Only: true

  The product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Read Only: true

  The name of the program in which the transaction is created. There is no default value, dependency, or limitation associated with this attribute.
• PromoObjectVersionNumber: integer (int32)
  Title: Object Version Number

  Read Only: true

  The promotion object number associated with the point item. Oracle Loyalty Cloud populates this value when the point item is created in the UI. There is no default value, dependency, or limitation associated with this attribute.
• PromotionName: string
  Title: Promotion

  Read Only: true

  Maximum Length: 50

  The name of the promotion that has been applied and for which the accrual items are created during transaction processing. There is no default value, dependency, or limitation associated with this attribute.
• PromotionNumber: string
  Title: Promotion Number

  Read Only: true

  Maximum Length: 30

  The promotion number that has been applied to the member and associated with the point item. There is no default value, dependency, or limitation associated with this attribute.
• QualifyingFlag: boolean
  Title: Qualifying

  Maximum Length: 1

  Default Value: false

  The boolean attribute indicates whether the accrued points are qualifying points or not. Qualifying points count toward a member???s tier status. The default value is N. There is no dependency or limitation associated with this attribute.
• Status: string
  Title: Status Meaning

  Read Only: true

  Maximum Length: 80

  The point item status, which shows whether a particular point item is active or not. There is no default value or limitation associated with this attribute.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  The code that represents the status of the accrual item. The accepted values are ORA_LOY_AVAILABLE, ORA_LOY_CANCELLED or ORA_LOY_EXPIRED. There is no default value, dependency, or limitation associated with this attribute.
• TransactionAmount: number
  Title: Amount

  Read Only: true

  The currency value amount of the transaction from transactions. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
• TransactionNumber: string
  Title: Transaction Number

  Maximum Length: 30

  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.
• TypeCode: string
  Title: Type Code

  Maximum Length: 30

  The point item type code associated with an order. There is no default value, dependency, or limitation associated with this attribute.
• UsedValue: number
  Title: Used Value

  The total points from the accrued points that have been used. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Created Date",
            "type":"string",
            "description":"The date when the accrual Item is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new transaction. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfPoints":{
            "title":"Number Points",
            "type":"number",
            "description":"The number of points that have been accrued as a result of accrual type transactions being processed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromoObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The promotion object number associated with the point item. Oracle Loyalty Cloud populates this value when the point item is created in the UI. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "TransactionNumber":{
            "title":"Transaction Number",
            "maxLength":"30",
            "type":"string",
            "description":"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,
            "x-queryable":true
        },
        "AccrualedValue":{
            "title":"Number of Points",
            "type":"number",
            "description":"The points accrued value for the points that are accrued by the member. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDt":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the points that have accrued expire. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The number associated with an order. This attribute is used by Oracle Loyalty Cloud when consolidating transactions. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ProdId":{
            "title":"Product ID",
            "type":"integer",
            "description":"The foreign key of loyalty products. 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
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code that represents the status of the accrual item. The accepted values are ORA_LOY_AVAILABLE, ORA_LOY_CANCELLED or ORA_LOY_EXPIRED. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessDt":{
            "title":"Processed 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 accrual items. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Point Subtype",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the point type that is accrued by the member. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccrualItemNumber":{
            "title":"Item Number",
            "maxLength":"30",
            "type":"string",
            "description":"The accrual item number reference which shows accrual information to reach this point balance. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "PromotionName":{
            "title":"Promotion",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the promotion that has been applied and for which the accrual items are created during transaction processing. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyAcrlItmId":{
            "title":"Loyalty Accrual Item ID",
            "type":"integer",
            "description":"The accrual item identifier to identify which accrual item has a specific point balance value. There is no default value or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UsedValue":{
            "title":"Used Value",
            "type":"number",
            "description":"The total points from the accrued points that have been used. 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 point type for which the accrual Item is created during transaction processing. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionNote":{
            "title":"Action Note",
            "maxLength":"1000",
            "type":"string",
            "description":"The attribute indicates additional information pertaining to an accrual action that resulted in the creation of the accrual item. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberNumber":{
            "type":"string",
            "description":"The member for whom the accrual item is created. 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"
            }
        },
        "ExpiredValue":{
            "type":"number",
            "description":"The point items which have expired. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AccrualEffDt":{
            "title":"Accrual Start Date",
            "type":"string",
            "description":"Displays the date from which the points would be effective, that is, the date when the points are available for redemption. Point items having a future effective date will fall under the 'Future Points' category and would move under 'Available Points' once the effectivity date is reached. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The point item status, which shows whether a particular point item is active or not. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PointBlkId":{
            "title":"Point Block ID",
            "type":"integer",
            "description":"The attribute indicates the primary key of the point block from which the accrued points are allocated to the member. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The point item type code associated with an order. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductNumber":{
            "type":"string",
            "description":"The product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramName":{
            "type":"string",
            "description":"The name of the program in which the transaction is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The currency value amount of the transaction from transactions. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Active":{
            "title":"Active",
            "maxLength":"1",
            "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
        },
        "PromotionNumber":{
            "title":"Promotion Number",
            "maxLength":"30",
            "type":"string",
            "description":"The promotion number that has been applied to the member and associated with the point item. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifyingFlag":{
            "title":"Qualifying",
            "maxLength":"1",
            "type":"boolean",
            "description":"The boolean attribute indicates whether the accrued points are qualifying points or not. Qualifying points count toward a member???s tier status. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "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