Jump to

• Request
• Response
• Examples

Get a loyalty product detail

get

/crmRestApi/resources/11.13.18.05/loyProducts/{loyProductsUniqID}

Request

Path Parameters

• loyProductsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Loyalty Products resource and used to uniquely identify an instance of Loyalty Products. The client should not generate the hash key value. Instead, the client should query on the Loyalty Products collection resource in order to navigate to a specific instance of Loyalty Products 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 : loyProducts-item-response

Type: object

Show Source

• CreatedBy: string
  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.
• CreationDate: string (date-time)
  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.
• InternalName: string
  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.
• ItemNumber: string
  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.
• LastUpdateDate: string (date-time)
  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.
• LastUpdatedBy: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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
  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.
• PartyNumber: string
  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.
• PointTypeName: string
  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.
• ProdRedempComments: string
  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.
• ProdRedempEndDt: string (date)
  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.
• ProdRedempStartDt: string (date)
  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.
• ProdRedemptionPoint: integer (int32)
  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.
• ProdRedempURL: string
  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.
• ProductName: string
  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.
• ProgramName: string
  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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The text field that indicates the user who last updated the row. There is no default value or dependency associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "ProdRedempEndDt":{
            "title":"End Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The text field that indicates the user who created the row. There is no default value or dependency associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProdRedemptionPoint":{
            "title":"Points",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ProdRedempURL":{
            "title":"Product Redemption URL",
            "maxLength":1000,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PointTypeName":{
            "title":"Point Type Name",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "InternalName":{
            "title":"Internal Name",
            "maxLength":75,
            "type":"string",
            "description":"The internal name of the loyalty point type. 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 program name. This attribute is also a parameter in the redemptionProductsFinder finder. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberPointBalance":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProdRedempComments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Product Number",
            "maxLength":300,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProdRedempStartDt":{
            "title":"Start Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "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."
        }
    }
}

Links

ItemPVO1

Operation: /crmRestApi/resources/11.13.18.05/products

Parameters:

• finder: ProductList%3BBind_UsageCode%3DLOYALTY%2CBind_UsageModeCode%3DLOY

The list of names of products for the loyalty redemption products.

The following properties are defined on the LOV link relation:

• Source Attribute: ProductName; Target Attribute: Name
• Display Attribute: Name

Back to Top

Examples

This example shows how to retrieve all the products for a given program..

Use GET with the following URI syntax to retrieve all the products for an example program called A2Z Bank using the redemptionProductsFinder finder:

https://example.com:port/crmRestApi/resources/11.13.18.05/loyProducts?finder=redemptionProductsFinder;ProgramName=A2Z Bank,TransactionDate=2018-05-05

Example of Response Header

cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -689
content-type -application/vnd.oracle.adf.resourcecollection+json
date -Mon, 20 Aug 2018 21:54:55 GMT
keep-alive -timeout=61, max=100
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 -005SyJphX39EoIILIqL6if0001wh00014u

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"
                }
            ]
        }
    ],
    "count": 1,
    "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