Get Loyalty Transaction Entries

GET

api

loyalty

transaction_entries

Copy
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.getTransactionEntries();

  console.log(response.data);
}

main();

Copy
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174040",
      "organizationId": "123e4567-e89b-12d3-a456-426614174001",
      "websiteId": "123e4567-e89b-12d3-a456-426614174002",
      "loyaltyAccountId": "123e4567-e89b-12d3-a456-426614174050",
      "direction": "credit",
      "type": "loyalty_rule",
      "createdAt": "2023-10-01T12:34:56Z",
      "updatedAt": "2023-10-05T15:30:00Z",
      "amount": 100,
      "metadata": {
        "orderId": "order123"
      },
      "loyaltyTransaction": {
        "id": "123e4567-e89b-12d3-a456-426614174060",
        "type": "order",
        "loyaltyRule": {
          "id": "123e4567-e89b-12d3-a456-426614174070",
          "name": "First Purchase Bonus",
          "description": "Bonus points for the first purchase",
          "type": "purchase",
          "metadata": {
            "category": "electronics"
          }
        }
      }
    }
  ],
  "hasNextPage": true
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

organizationId

string

Unique identifier for the organization to filter by

Example:

"123e4567-e89b-12d3-a456-426614174001"

websiteId

string

Unique identifier for the website to filter by

Example:

"123e4567-e89b-12d3-a456-426614174002"

startingAfter

string

Pagination cursor to start after a specific resource ID

Example:

"123e4567-e89b-12d3-a456-426614174010"

limit

integer

default:10

Maximum number of records to return (max 1000)

Required range: 1 <= x <= 1000

Example:

50

walletAddress

Wallet address or array of wallet addresses to filter by

Example:

[
  "0x1234567890abcdef1234567890abcdef12345678"
]

userId

User ID or array of User IDs to filter by

Example:

["123e4567-e89b-12d3-a456-426614174000"]

walletGroupIdentifier

string

Identifier for the wallet group to filter by

Example:

"group123"

loyaltyTransactionId

string

Unique identifier for the loyalty transaction to filter by

Example:

"123e4567-e89b-12d3-a456-426614174020"

loyaltyRuleId

string

Unique identifier for the loyalty rule to filter by

Example:

"123e4567-e89b-12d3-a456-426614174030"

loyaltyRuleType

Available options:

Bonus,

BoughtOn,

BoughtWithRoyalties,

DiscordMessages,

Listing,

Lodging,

MintOn,

PoapClaim,

SnagSocialsConnected,

SnapshotFullset,

SnapshotHold,

SoldOn,

SoldWithRoyalties,

TokenHold,

TwitterBio,

TwitterHashTagPost,

Retweet,

check_in,

code_entry,

connect_wallet,

connected_discord,

connected_email,

connected_epic,

connected_steam,

connected_telegram,

connected_twitter,

create_partner_account,

discord_member,

drip_x_follow,

drip_x_new_tweet,

drip_x_text_in_bio,

drip_x_text_in_comment,

drip_x_text_in_name,

drip_x_tweet,

external_rule,

link_click,

manual_upload,

profile_completed,

referred_user,

smart_contract_event,

snapshot_governance,

telegram_join,

telegram_messages,

text_input,

token_hold_erc20,

tweet_liked_by_project,

twitter_comment,

twitter_follow,

twitter_followers,

twitter_like,

twitter_post_hashtag,

quiz,

poll

idempotencyKey

string

Key to ensure idempotency of the request

Example:

"idempkey123"

direction

enum<string>

Direction of the transaction entry to filter by

Available options:

credit,

debit

Example:

"credit"

type

enum<string>

Type of the loyalty transaction to filter by

Available options:

auction_bid,

direct_mint,

loyalty_rule,

api_key,

order

Example:

"loyalty_rule"

orderBy

enum<string>

default:createdAt

Field to order the results by

Available options:

createdAt,

updatedAt,

loyaltyAccountLockVersion

Example:

"createdAt"

userCompletedLoyaltyRuleId

When passed in return the list of fulfilled entries for loyalty rules. If a loyalty rule has a fulfilled entry this means the user cannot currently complete the rule. Must be passed in with userId or walletAddress.

Example:

"123e4567-e89b-12d3-a456-426614174030"

userGroupExternalIdentifier

string

External identifier for the user group controlled by you

userGroupId

string

Unique identifier for the user group

Example:

"123e4567-e89b-12d3-a456-426614174090"

createdAtStart

string

Start date to filter by (inclusive, greater than or equal to)

Example:

"2023-10-01T12:34:56Z"

createdAtEnd

string

End date to filter by (exclusive, less than)

Example:

"2023-10-01T12:34:56Z"

Response

200

application/json

200

data

object[]

required

Schema for a loyalty transaction entry

data.id

string

required

Unique identifier for the transaction entry

Example:

"123e4567-e89b-12d3-a456-426614174040"

data.organizationId

string

required

Unique identifier for the organization

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.websiteId

string

required

Unique identifier for the website

Example:

"123e4567-e89b-12d3-a456-426614174002"

data.loyaltyAccountId

string

required

Unique identifier for the loyalty account

Example:

"123e4567-e89b-12d3-a456-426614174050"

data.direction

enum<string>

required

Direction of the transaction entry

Available options:

credit,

debit

Example:

"credit"

data.type

enum<string>

required

Type of the loyalty transaction

Available options:

auction_bid,

direct_mint,

loyalty_rule,

api_key,

order

Example:

"loyalty_rule"

data.createdAt

string

required

Timestamp when the transaction entry was created

Example:

"2023-10-01T12:34:56Z"

data.updatedAt

string

required

Timestamp when the transaction entry was last updated

Example:

"2023-10-05T15:30:00Z"

data.amount

number

required

Amount involved in the transaction

Example:

100

data.loyaltyTransaction

object

required

Details of the loyalty transaction

data.loyaltyTransaction.id

string

required

Unique identifier for the loyalty transaction

Example:

"123e4567-e89b-12d3-a456-426614174060"

data.loyaltyTransaction.type

enum<string>

required

Type of the loyalty transaction

Available options:

auction_bid,

direct_mint,

loyalty_rule,

api_key,

order

Example:

"order"

data.loyaltyTransaction.loyaltyRule

object

Details of the loyalty rule associated with the transaction

data.loyaltyTransaction.loyaltyRule.id

string

required

Unique identifier for the loyalty rule

Example:

"123e4567-e89b-12d3-a456-426614174070"

data.loyaltyTransaction.loyaltyRule.type

string

required

Type of the loyalty rule

Example:

"purchase"

data.loyaltyTransaction.loyaltyRule.name

string

Name of the loyalty rule

Example:

"First Purchase Bonus"

data.loyaltyTransaction.loyaltyRule.description

string

Description of the loyalty rule

Example:

"Bonus points for the first purchase"

data.loyaltyTransaction.loyaltyRule.metadata

object

Optional metadata for the loyalty rule

Example:

{ "category": "electronics" }

data.metadata

object

Optional metadata for the transaction entry

Example:

{ "orderId": "order123" }

hasNextPage

boolean

required

Was this page helpful?

Create Loyalty Transaction Get Loyalty Rule Chains

Copy
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.getTransactionEntries();

  console.log(response.data);
}

main();

Copy
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174040",
      "organizationId": "123e4567-e89b-12d3-a456-426614174001",
      "websiteId": "123e4567-e89b-12d3-a456-426614174002",
      "loyaltyAccountId": "123e4567-e89b-12d3-a456-426614174050",
      "direction": "credit",
      "type": "loyalty_rule",
      "createdAt": "2023-10-01T12:34:56Z",
      "updatedAt": "2023-10-05T15:30:00Z",
      "amount": 100,
      "metadata": {
        "orderId": "order123"
      },
      "loyaltyTransaction": {
        "id": "123e4567-e89b-12d3-a456-426614174060",
        "type": "order",
        "loyaltyRule": {
          "id": "123e4567-e89b-12d3-a456-426614174070",
          "name": "First Purchase Bonus",
          "description": "Bonus points for the first purchase",
          "type": "purchase",
          "metadata": {
            "category": "electronics"
          }
        }
      }
    }
  ],
  "hasNextPage": true
}

API Documentation

Asset

Auction

Identity

Loyalty

Badge

Minting

Question

Referrals

Website

Get Loyalty Transaction Entries

Authorizations

Query Parameters

Response