Check Customer Loyalty Data
AI-generatedSummary
Check customer loyalty data by providing either a CPF or phone number, and optionally request the customer's current loyalty tier.
Inputs
- CPF — Customer CPF (required if phone is not provided) used to identify the customer.
- Phone — Customer phone number in format (11)99999-9999 (required if CPF is not provided) used to identify the customer.
- Return Category — Boolean flag to indicate whether to include the customer's current loyalty tier in the response.
Output shape
a list of JSON objects each containing loyalty data per input item
Each output item contains: customerExists (boolean), balance (points), cashback amount, category (loyalty tier string if requested), frozen status boolean, availableRewards array (with reward name, description, imageUrl, identifier, and required points), responseCode, and errorMessage. If an error occurs for an item and 'Continue On Fail' is enabled, the error is returned in the corresponding item's json.error field.
Examples
Example 1: Check loyalty data for one or more customers by specifying either CPF or phone number for each input item, optionally including their loyalty category.
Set 'CPF' or 'Phone' (at least one per item). Set 'Return Category' to true if loyalty tier is desired.