API Documentation
Identity
- POSTCreate user device
- GETGet user metadata
- POSTCreate user metadata
- GETGet users
- GETUser count
- POSTConnect a user to User Group
- POSTDisconnect a user from User Group
- GETConnect Auth
- POSTPost apiusersverify
- GETGet all website user attributes
- POSTCreate a new website user attribute
- DELDelete a website user attribute
- GETGet all website user attribute values
- POSTCreate a new website user attribute value
Loyalty
- GETGet loyalty accounts
- GETGet the rank of a user based on their loyalty points
- GETGet loyalty currencies
- POSTCreate a loyalty currency
- GETGet Loyalty Multipliers
- POSTCreate Loyalty Multiplier
- DELDelete Loyalty Multiplier by External Identifier
- POSTUpdate Loyalty Multiplier
- DELDelete Loyalty Multiplier by ID
- GETGet Loyalty Rule Edits
- POSTRestore Loyalty Rule Edit
- GETGet Loyalty Rule Groups
- POSTCreate Loyalty Rule Groups
- POSTUpdate Loyalty Rule Group
- DELDelete Loyalty Rule Group
- GETGet Loyalty Rules
- POSTCreate Loyalty Rule
- POSTUpdate Loyalty Rule
- DELDelete Loyalty Rule
- POSTComplete Loyalty Rule
- GETGet Processing status for a specific user on loyalty rules
- POSTCreate Loyalty Transaction
- GETGet Loyalty Transaction Entries
- GETGet Loyalty Rule Chains
- GETGet Loyalty Rule Statuses
- POSTUpdate Loyalty Rule Status
Badge
Minting
Question
Website
Landing Page
Get Loyalty Rule Chains
Retrieve configured loyalty rule chains
import SnagSolutions from '@snagsolutions/sdk';
const client = new SnagSolutions({
apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});
async function main() {
const response = await client.loyalty.transactions.listRuleChains({
organizationId: '123e4567-e89b-12d3-a456-426614174001',
websiteId: '123e4567-e89b-12d3-a456-426614174002',
});
console.log(response.data);
}
main();
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174001",
"name": "My Rule Chain",
"loyaltyRuleId": "123e4567-e89b-12d3-a456-426614174111",
"loyaltyConditions": [
{
"id": "123e4567-e89b-12d3-a456-426614174001",
"type": "rule",
"description": "My Condition",
"amount": 100,
"repeatCount": 1,
"requiredCount": 1,
"csvUrl": "https://example.com/csv",
"association": [
{
"id": "123e4567-e89b-12d3-a456-426614174001",
"loyaltyRuleGroupId": "123e4567-e89b-12d3-a456-426614174001",
"loyaltyRuleId": "123e4567-e89b-12d3-a456-426614174111",
"loyaltyCurrencyId": "123e4567-e89b-12d3-a456-426614174001",
"loyaltyBadgeId": "123e4567-e89b-12d3-a456-426614174001",
"loyaltyRule": {
"name": "My Loyalty Rule"
}
}
]
}
]
}
],
"hasNextPage": true
}
Authorizations
Query Parameters
Unique identifier for the organization
"123e4567-e89b-12d3-a456-426614174001"
Unique identifier for the website
"123e4567-e89b-12d3-a456-426614174002"
Number of rule chains to return
10
Starting after the given rule chain ID
"123e4567-e89b-12d3-a456-426614174002"
Response
Unique identifier for the rule chain
"123e4567-e89b-12d3-a456-426614174001"
Name of the rule chain
"My Rule Chain"
Unique identifier for the loyalty rule
"123e4567-e89b-12d3-a456-426614174111"
Unique identifier for the condition
"123e4567-e89b-12d3-a456-426614174001"
Type of the condition
rule
, rules
, points
, section
, level
, api
, badge
, badges
, csv
"rule"
Description of the condition
"My Condition"
Amount of the condition
100
Number of times the condition must be met
1
Number of times the condition must be met
1
URL of the CSV file
"https://example.com/csv"
Unique identifier for the association
"123e4567-e89b-12d3-a456-426614174001"
Unique identifier for the loyalty rule group
"123e4567-e89b-12d3-a456-426614174001"
Unique identifier for the loyalty rule
"123e4567-e89b-12d3-a456-426614174111"
Unique identifier for the loyalty currency
"123e4567-e89b-12d3-a456-426614174001"
Unique identifier for the loyalty badge
"123e4567-e89b-12d3-a456-426614174001"
Was this page helpful?
import SnagSolutions from '@snagsolutions/sdk';
const client = new SnagSolutions({
apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});
async function main() {
const response = await client.loyalty.transactions.listRuleChains({
organizationId: '123e4567-e89b-12d3-a456-426614174001',
websiteId: '123e4567-e89b-12d3-a456-426614174002',
});
console.log(response.data);
}
main();
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174001",
"name": "My Rule Chain",
"loyaltyRuleId": "123e4567-e89b-12d3-a456-426614174111",
"loyaltyConditions": [
{
"id": "123e4567-e89b-12d3-a456-426614174001",
"type": "rule",
"description": "My Condition",
"amount": 100,
"repeatCount": 1,
"requiredCount": 1,
"csvUrl": "https://example.com/csv",
"association": [
{
"id": "123e4567-e89b-12d3-a456-426614174001",
"loyaltyRuleGroupId": "123e4567-e89b-12d3-a456-426614174001",
"loyaltyRuleId": "123e4567-e89b-12d3-a456-426614174111",
"loyaltyCurrencyId": "123e4567-e89b-12d3-a456-426614174001",
"loyaltyBadgeId": "123e4567-e89b-12d3-a456-426614174001",
"loyaltyRule": {
"name": "My Loyalty Rule"
}
}
]
}
]
}
],
"hasNextPage": true
}