Get all loyalty products

get

/crmRestApi/resources/11.13.18.05/loyProducts

Request

Query Parameters
  • 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:

    • redemptionProductsFinder: Finds a redemption product with a specified member number, point type name, partner party number, product item number, loyalty program name and date when the transaction takes place.
      Finder Variables:
      • DisplayName; string; The loyalty point type name.
      • ItemNumber; string; The loyalty product item number.
      • MemberNumber; string; The loyalty member number.
      • PartyNumber; string; The loyalty partner party number.
      • ProgramName; string; The loyalty program name.
      • TransactionDate; string; The date when the transaction takes place.
  • 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:
    • CreatedBy; string; The text field that indicates the user who created the row. There is no default value or dependency associated with this attribute.
    • CreationDate; string; The date field that indicates the date and time of the creation of the row. There is no default value or dependency associated with this attribute.
    • InternalName; string; The internal name of the loyalty point type. There is no default value, dependency, or limitation associated with this attribute.
    • ItemNumber; string; The item number of the product. This is the product number for which Oracle Loyalty Cloud shows the redemption points. There is no default value, dependency, or limitation associated with this attribute.
    • LastUpdateDate; string; The date field that indicates the date and time of the last update of the row. There is no default value or dependency associated with this attribute.
    • LastUpdatedBy; string; The text field that indicates the user who last updated the row. There is no default value or dependency associated with this attribute.
    • MemberPointBalance; number; The loyalty member's point balance for a given point type. This value shows the Member Check Credit functionality when the MemberNumber parameter is provided for the redemptionProductsFinder finder to show both the redemption points for each product and the point balance for the member as a credit check feature. There is no default value, dependency, or limitation associated with this attribute.
    • PartyName; string; The party name of the loyalty partner. This information shows the name of partner for a given partner party number. There is no default value or dependency associated with this attribute.
    • PartyNumber; string; The party number of the loyalty partner. This attribute is also a parameter in the redemptionProductsFinder finder. There is no default value or dependency associated with this attribute.
    • ProdRedempComments; string; The text field that indicates the comments added by the loyalty administrator in a redemption product record. There is no default value, dependency, or limitation associated with this attribute.
    • ProdRedempEndDt; string; The end date for product redemption, that is, the date when the redemption product is no longer in effect. This date is the value of the TransactionDate parameter returned by the redemptionProductsFinder finder search in between the ProdRedempStartDt and ProdProdRedempEndDt attributes. There is no default value, dependency, or limitation associated with this attribute.
    • ProdRedempStartDt; string; The start date for product redemption, that is, the date when the redemption product comes into effect. This date is the value of the TransactionDate parameter returned by the redemptionProductsFinder finder search in between the ProdRedempStartDt and ProdProdRedempEndDt attributes. There is no default value, dependency, or limitation associated with this attribute.
    • ProdRedempURL; string; The text field that specifies the redemption URL for the product that is enabled for redemption. There is no default value, dependency, or limitation associated with this attribute.
    • ProdRedemptionPoint; integer; The points required to redeem the product. Each product requires a point value that indicates the points required when a member redeems the product. There is no default value, dependency, or limitation associated with this attribute.
    • ProductName; string; The product name. This name describes the product for a given ItemNumber filter parameter when using the redemptionProductsFinder finder. Oracle Loyalty Cloud shows the product for the ProdRedemptionPoint value. There is no default value, dependency, or limitation associated with this attribute.
    • ProgramName; string; The program name. This attribute is also a parameter in the redemptionProductsFinder finder. 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 : loyProducts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : loyProducts-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The text field that indicates the user who created the row. There is no default value or dependency associated with this attribute.
  • Title: Creation Date
    Read Only: true
    The date field that indicates the date and time of the creation of the row. There is no default value or dependency associated with this attribute.
  • Title: Internal Name
    Read Only: true
    Maximum Length: 75
    The internal name of the loyalty point type. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Product Number
    Read Only: true
    Maximum Length: 300
    The item number of the product. This is the product number for which Oracle Loyalty Cloud shows the redemption points. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Update Date
    Read Only: true
    The date field that indicates the date and time of the last update of the row. There is no default value or dependency associated with this attribute.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The text field that indicates the user who last updated the row. There is no default value or dependency associated with this attribute.
  • Links
  • The loyalty member's point balance for a given point type. This value shows the Member Check Credit functionality when the MemberNumber parameter is provided for the redemptionProductsFinder finder to show both the redemption points for each product and the point balance for the member as a credit check feature. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The party name of the loyalty partner. This information shows the name of partner for a given partner party number. There is no default value or dependency associated with this attribute.
  • Title: Registry ID
    Read Only: true
    Maximum Length: 30
    The party number of the loyalty partner. This attribute is also a parameter in the redemptionProductsFinder finder. There is no default value or dependency associated with this attribute.
  • Title: Point Type Name
    The name of the point type. This is also a parameter in the redemptionProductsFinder finder. If the value not provided, the finder lists the ProdRedemptionPoint attribute value for all possible point types in a given program name. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Comments
    Maximum Length: 1000
    The text field that indicates the comments added by the loyalty administrator in a redemption product record. There is no default value, dependency, or limitation associated with this attribute.
  • Title: End Date
    The end date for product redemption, that is, the date when the redemption product is no longer in effect. This date is the value of the TransactionDate parameter returned by the redemptionProductsFinder finder search in between the ProdRedempStartDt and ProdProdRedempEndDt attributes. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Start Date
    The start date for product redemption, that is, the date when the redemption product comes into effect. This date is the value of the TransactionDate parameter returned by the redemptionProductsFinder finder search in between the ProdRedempStartDt and ProdProdRedempEndDt attributes. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Points
    The points required to redeem the product. Each product requires a point value that indicates the points required when a member redeems the product. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Product Redemption URL
    Maximum Length: 1000
    The text field that specifies the redemption URL for the product that is enabled for redemption. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Product
    The product name. This name describes the product for a given ItemNumber filter parameter when using the redemptionProductsFinder finder. Oracle Loyalty Cloud shows the product for the ProdRedemptionPoint value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Program
    Read Only: true
    Maximum Length: 50
    The program name. This attribute is also a parameter in the redemptionProductsFinder finder. There is no default value, dependency, or limitation associated with this attribute.
Back to Top

Examples

This example shows how to retrieve a catalog of all loyalty products.

Use GET with the following URI syntax to retrieve the catalog of all loyalty products:

https://example.com:port/crmRestApi/resources/11.13.18.05/loyProducts

Example of Response Header

cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -1235
content-type -application/vnd.oracle.adf.resourcecollection+json
date -Mon, 20 Aug 2018 20:49:20 GMT
keep-alive -timeout=61, max=99
link - <https://example.com:port/crmRestApi/resources/11.13.18.05/loyProducts>;rel="self";kind="collection";name="loyProducts"
location -
rest-framework-version -1
server -Oracle-HTTP-Server
vary -User-Agent
x-content-type-options -nosniff
x-oracle-dms-ecid -005SyGBBAN8EoIILIqL6if0001wh00010i

Example of Response Body

{
    "items": [
        {
            "ProdRedempEndDt": "2019-11-29",
            "ProdRedempStartDt": "2017-11-29",
            "ProdRedemptionPoint": 4000,
            "ProductName": "Club Vitara New Delhi to Bangalore Economy",
            "PointTypeName": "Bits",
            "InternalName": "PointTypeAVal",
            "ItemNumber": "CV001",
            "MemberPointBalance": null,
            "PartyName": null,
            "PartyNumber": null,
            "ProgramName": "A2Z Bank",
            "ProdRedempComments": null,
            "ProdRedempURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyProducts/00060000000EACED00057708000110F0819AFADC0000000EACED00057708000110F0819AFAC80000000EACED00057708000110F0819AFACC0000000EACED00057708000110F08172A470FFFFFFFF0000000EACED0005770800000000000000CC",
                    "name": "loyProducts",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyProducts/00060000000EACED00057708000110F0819AFADC0000000EACED00057708000110F0819AFAC80000000EACED00057708000110F0819AFACC0000000EACED00057708000110F08172A470FFFFFFFF0000000EACED0005770800000000000000CC",
                    "name": "loyProducts",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyProducts/00060000000EACED00057708000110F0819AFADC0000000EACED00057708000110F0819AFAC80000000EACED00057708000110F0819AFACC0000000EACED00057708000110F08172A470FFFFFFFF0000000EACED0005770800000000000000CC/lov/ItemPVO1",
                    "name": "ItemPVO1",
                    "kind": "collection"
                }
            ]
        },
        {
            "ProdRedempEndDt": null,
            "ProdRedempStartDt": "2018-08-01",
            "ProdRedemptionPoint": 10,
            "ProductName": "Linux",
            "PointTypeName": "Base",
            "InternalName": "PointTypeAVal",
            "ItemNumber": "TG2",
            "MemberPointBalance": null,
            "PartyName": "Avengers Inc",
            "PartyNumber": "CDRM_71324",
            "ProgramName": "Auto Miles19c14810469",
            "ProdRedempComments": null,
            "ProdRedempURL": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyProducts/00060000000EACED00057708000110F0819AF8D20000000EACED00057708000110F0819AD5950000000EACED00057708000110F0819AD59E0000000EACED0005770800038D7E0FCDE9370000000EACED00057708000110F07BE02EAA0000000EACED0005770800000000000000CC",
                    "name": "loyProducts",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyProducts/00060000000EACED00057708000110F0819AF8D20000000EACED00057708000110F0819AD5950000000EACED00057708000110F0819AD59E0000000EACED0005770800038D7E0FCDE9370000000EACED00057708000110F07BE02EAA0000000EACED0005770800000000000000CC",
                    "name": "loyProducts",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyProducts/00060000000EACED00057708000110F0819AF8D20000000EACED00057708000110F0819AD5950000000EACED00057708000110F0819AD59E0000000EACED0005770800038D7E0FCDE9370000000EACED00057708000110F07BE02EAA0000000EACED0005770800000000000000CC/lov/ItemPVO1",
                    "name": "ItemPVO1",
                    "kind": "collection"
                }
            ]
        },
.
.
.
    "count": 10,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyProducts",
            "name": "loyProducts",
            "kind": "collection"
        }
    ]
}
Back to Top