Get Loyalty Rule Edits

GET

api

loyalty

rule_edits

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 ruleEdits = await client.loyalty.ruleEdits.list({ loyaltyRuleId: true });

  console.log(ruleEdits.data);
}

main();

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "loyaltyRuleId": "123e4567-e89b-12d3-a456-426614174001",
      "websiteId": "123e4567-e89b-12d3-a456-426614174002",
      "organizationId": "123e4567-e89b-12d3-a456-426614174003",
      "editedByUserId": "123e4567-e89b-12d3-a456-426614174004",
      "editedAt": "2021-08-30T20:00:00Z",
      "action": "create",
      "data": {
        "name": "New Rule Name"
      },
      "previousData": {
        "name": "Old Rule Name"
      },
      "comment": "Updated rule name"
    }
  ],
  "hasNextPage": true
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

loyaltyRuleId

boolean

required

ID of the loyalty rule

Example:

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

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 rule edit ID

Example:

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

limit

integer

Maximum number of edits to return

Required range: 1 <= x <= 1000

Example:

20

Response

200

application/json

200

data

object[]

required

data.id

string

required

Unique identifier for the rule edit

Example:

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

data.loyaltyRuleId

string

required

ID of the loyalty rule

Example:

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

data.websiteId

string

required

Unique identifier for the website

Example:

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

data.organizationId

string

required

Unique identifier for the organization

Example:

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

data.editedByUserId

string

required

User ID of the user who made the edit

Example:

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

data.editedAt

string

required

Timestamp of when the rule edit was made

Example:

"2021-08-30T20:00:00Z"

data.action

enum<string>

required

Type of action that was made on the rule

Available options:

create,

update,

delete,

restore

Example:

"create"

data.data

object

required

Data that was changed on the rule

data.data.id

string

required

Unique identifier for the loyalty rule

Example:

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

data.data.organizationId

string

required

Unique identifier for the organization

Example:

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

data.data.websiteId

string

required

Unique identifier for the website

Example:

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

data.data.type

string

required

Type of the loyalty rule

Example:

"purchase"

data.data.frequency

string

required

Frequency of the loyalty rule

Example:

"daily"

data.data.amount

number

required

Amount associated with the loyalty rule

Example:

10

data.data.createdAt

string

required

Timestamp when the loyalty rule was created

Example:

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

data.data.updatedAt

string

required

Timestamp when the loyalty rule was last updated

Example:

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

data.data.deletedAt

string | null

required

Timestamp when the loyalty rule was deleted (if applicable)

Example:

null

data.data.collectionAddress

string

Optional address of the collection

Example:

"0x1234567890abcdef1234567890abcdef12345678"

data.data.metadata

object

Optional metadata for the loyalty rule

Example:

{ "key": "value" }

Example:

{ "name": "New Rule Name" }

data.previousData

object

Previous data of the rule before the edit

data.previousData.id

string

required

Unique identifier for the loyalty rule

Example:

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

data.previousData.organizationId

string

required

Unique identifier for the organization

Example:

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

data.previousData.websiteId

string

required

Unique identifier for the website

Example:

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

data.previousData.type

string

required

Type of the loyalty rule

Example:

"purchase"

data.previousData.frequency

string

required

Frequency of the loyalty rule

Example:

"daily"

data.previousData.amount

number

required

Amount associated with the loyalty rule

Example:

10

data.previousData.createdAt

string

required

Timestamp when the loyalty rule was created

Example:

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

data.previousData.updatedAt

string

required

Timestamp when the loyalty rule was last updated

Example:

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

data.previousData.deletedAt

string | null

required

Timestamp when the loyalty rule was deleted (if applicable)

Example:

null

data.previousData.collectionAddress

string

Optional address of the collection

Example:

"0x1234567890abcdef1234567890abcdef12345678"

data.previousData.metadata

object

Optional metadata for the loyalty rule

Example:

{ "key": "value" }

Example:

{ "name": "Old Rule Name" }

data.comment

string

Comment that was made on the edit

Example:

"Updated rule name"

hasNextPage

boolean

required

Was this page helpful?

Delete Loyalty Multiplier by ID Restore Loyalty Rule Edit

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 ruleEdits = await client.loyalty.ruleEdits.list({ loyaltyRuleId: true });

  console.log(ruleEdits.data);
}

main();

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "loyaltyRuleId": "123e4567-e89b-12d3-a456-426614174001",
      "websiteId": "123e4567-e89b-12d3-a456-426614174002",
      "organizationId": "123e4567-e89b-12d3-a456-426614174003",
      "editedByUserId": "123e4567-e89b-12d3-a456-426614174004",
      "editedAt": "2021-08-30T20:00:00Z",
      "action": "create",
      "data": {
        "name": "New Rule Name"
      },
      "previousData": {
        "name": "Old Rule Name"
      },
      "comment": "Updated rule name"
    }
  ],
  "hasNextPage": true
}

API Documentation

Asset

Auction

Identity

Loyalty

Badge

Minting

Question

Referrals

Website

Get Loyalty Rule Edits

Authorizations

Query Parameters

Response