Get all point items for a given loyalty member

get

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

Request

Path Parameters
  • 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.
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey
      Finder Variables:
      • LoyAcrlItmId
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AccrualEffDt; string; 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; 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.
    • AccrualedValue; number; 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.
    • ActionNote; string; 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; 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; 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; 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; 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.
    • LoyAcrlItmId; integer; 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; 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; 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; 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; 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; 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; 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; The product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute.
    • ProgramName; string; 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; 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; 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; 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; 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; 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; 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; 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; 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; The point item type code associated with an order. There is no default value, dependency, or limitation associated with this attribute.
    • UsedValue; number; The total points from the accrued points that have been used. There is no default value, dependency, or limitation associated with this attribute.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : loyMembers-pointItems-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Expiration Date
    The date when the points that have accrued expire. There is no default value, dependency, or limitation associated with this attribute.
  • The point items which have expired. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • 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.
  • The member for whom the accrual item is created. There is no default value, dependency, or limitation associated with this attribute.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    The product that is used in the transaction. There is no default value, dependency, or limitation associated with this attribute.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
Back to Top