Navigation: Catalog: Brevo > Schemas > Schema: Reward > Tables

LoyaltyOfferProgramsByPidRewards_ProductsRid

Get reward informationReturns reward information.

Catalog: Brevo

Schema: Reward

This is a read-only table function. The Sendinblue API may not support changing the data or the Invantive UniversalSQL driver for Sendinblue does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Sendinblue API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function LoyaltyOfferProgramsByPidRewards_ProductsRid. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Required	Documentation
pid	☑	Loyalty Program ID
rid	☑	Reward ID
version	☐	Version (Values: active, draft)

Columns of Table Function

The columns of the table function LoyaltyOfferProgramsByPidRewards_ProductsRid are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
attributionPerConsumer	int64		☐	Maximum number of times a consumer can be attributed this reward
balanceDefinitionId	guid		☐	Unique identifier for the balance definition
code	varchar2		☐	Unique code for the reward
codeCount	int64		☐	Total number of codes generated
codeGeneratorId	guid		☐	Unique identifier for the code generator
codePoolId	guid		☐	Unique identifier for the code pool
config	varchar2		☐	Configuration settings for the reward
createdAt_2	datetime		☐	Timestamp when the reward was created
createdAt	varchar2	Creation Date	☐	Timestamp when the product was created
disabledAt	datetime		☐	Disabled date of the reward
endDate	datetime	End Date	☐	End date of the reward validity
expirationDate	datetime		☐	Expiration date of the reward
expirationModifier	varchar2		☐	Select startOfPeriod to configure rewards expiry on start of day/week/month/year. Select endOfPeriod to configure reward expiry on end of day/week/month/year, else select noModification
expirationUnit	varchar2		☐	Unit of time for the rewards's availability (e.g., day/week/month/year).
expirationValue	int64		☐	Number of days/weeks/month/year for reward expiry
generator_createdAt	varchar2		☐	Timestamp when the reward was created
generator_description	varchar2		☐	Public facing description of the reward
generator_id	guid		☐	Unique identifier for the reward
generator_name	varchar2		☐	Name of the reward
generator_pattern	varchar2		☐	Generated pattern
generator_updatedAt	datetime		☐	Timestamp when the reward was created
id	guid	ID	☐	Unique identifier for the reward
imageRef	varchar2		☐	URL of the product image
loyaltyProgramId	guid		☐	Id of the loyalty program to which the current reward belongs to
meta	varchar2		☐	Additional data for reward definition
name	varchar2	Name	☐	Name of the reward
productId	varchar2		☐	Unique identifier for the product
publicDescription	varchar2		☐	Public description for the reward
publicImage	varchar2		☐	Public Image for the reward
publicName	varchar2		☐	Public name for the reward
redeemPerConsumer	int64		☐	Defines the redeem limit for the consumer
rewardConfigs_attribution	varchar2		☐	Attribution config of the reward
rewardConfigs_code	varchar2		☐	Code config of the reward
rewardConfigs_value	varchar2		☐	Value config of the reward
rule_condition_op	varchar2		☐	Selected operator for the rule
rule_createdAt	varchar2		☐	Timestamp when the rule was created
rule_description	varchar2		☐	Description of the rule
rule_event_name	varchar2		☐	Name of the event
rule_event_source	varchar2		☐	Source of the event
rule_isInternal	char		☐	Metric to identify if it's an internal rule or not
rule_loyaltyProgramId	varchar2		☐	Loyalty Program id to which current rule is associated
rule_loyaltyVersionId	int64		☐	Loyalty Version id to which current rule is associated
rule_meta	varchar2		☐	Additional data to define the rule
rule_name	varchar2		☐	Rule name
rule_ruleId	varchar2		☐	Unique identifier for the rule
rule_ruleType	varchar2		☐	Type of the rule
rule_updatedAt	varchar2		☐	Timestamp when the rule was updated
startDate	datetime	Start Date	☐	Start date of attribution of the reward
subtractBalanceDefinitionId	varchar2		☐	Id of the selected balance while redeeming / attributing a reward
subtractBalanceStrategy	varchar2		☐	Strategy of the Balance while redeeming / attributing a reward
subtractBalanceValue	int64		☐	Amount of balance to be selected while redeeming / attributing a reward
subtractTotalBalance	char		☐	Value to indicate to subtract full balance or not
totalAttribution	int64		☐	Defines the limit to which a consumer can attribute a reward
totalRedeem	int64		☐	Defines the limit to which a consumer can redeem a reward
triggerId	varchar2		☐	Id of the Rule to be updated for that reward
unit	varchar2		☐	Selected unit of the balance
updatedAt	varchar2		☐	Timestamp for when this reward was last updated.
value_2	decimal		☐	Value of metric in selected config for reward definition
value	varchar2	Value	☐	string
valueType	varchar2		☐	Type of config selected for reward definition

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Sendinblue API Data Model

LoyaltyOfferProgramsByPidRewards_ProductsRid

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information