POST
/
api
/
loyalty
/
currencies
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 currency = await client.loyalty.currencies.create({
    decimals: 2,
    name: 'Loyalty Points',
    organizationId: '123e4567-e89b-12d3-a456-426614174001',
    symbol: 'LP',
    websiteId: '123e4567-e89b-12d3-a456-426614174002',
  });

  console.log(currency.id);
}

main();
{
  "id": "123e4567-e89b-12d3-a456-426614174005",
  "organizationId": "123e4567-e89b-12d3-a456-426614174001",
  "websiteId": "123e4567-e89b-12d3-a456-426614174002",
  "imageUrl": "https://assets.snagsolutions.io/images/loyalty.png",
  "name": "Loyalty Points",
  "symbol": "LP",
  "decimals": 2,
  "createdById": "123e4567-e89b-12d3-a456-426614174010",
  "createdAt": "2023-10-01T12:34:56.000Z",
  "updatedAt": "2023-10-05T15:30:00.000Z",
  "apiGetUrl": "https://api.example.com/get-loyalty",
  "apiGetTransactionEntryUrl": "https://api.example.com/get-loyalty",
  "apiPostUrl": "https://api.example.com/post-loyalty",
  "apiAuthType": "basic",
  "apiAuthKey": "apiKey123",
  "apiAuthValue": "apiValue456",
  "sortId": 1,
  "deletedAt": null
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
Body

Schema for creating a new loyalty currency

​
organizationId
string
required

Unique identifier for the organization

Example:

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

​
websiteId
string
required

Unique identifier for the website

Example:

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

​
name
string
required

Name of the loyalty currency

Example:

"Loyalty Points"

​
symbol
string
required

Symbol representing the loyalty currency

Example:

"LP"

​
decimals
number
required

Number of decimal places for the currency

Required range: x >= 0
Example:

2

​
imageUrl
string | null

URL of the image; must start with AWS S3 asset URL base

Example:

"https://assets.snagsolutions.io/images/loyalty.png"

​
apiGetUrl
string | null

Optional API GET URL for fetching data

Minimum length: 1
Example:

"https://api.example.com/get-loyalty"

​
apiGetTransactionEntryUrl
string | null

Optional API GET URL for fetching transaction entry data

Minimum length: 1
Example:

"https://api.example.com/get-loyalty-tx"

​
apiPostUrl
string | null

Optional API POST URL for sending data

Minimum length: 1
Example:

"https://api.example.com/post-loyalty"

​
sortId
number

Optional sorting identifier

Example:

1

​
apiAuthType
enum<string> | null

Type of authentication used for API

Available options:
none,
basic,
bearer,
apiKey
Example:

"basic"

​
apiAuthKey
string | null

Authentication key for API

Minimum length: 1
Example:

"apiKey123"

​
apiAuthValue
string | null

Authentication value for API

Minimum length: 1
Example:

"apiValue456"

Response

200
application/json
200

Schema for a loyalty currency

​
id
string
required

Unique identifier for the loyalty currency

Example:

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

​
organizationId
string
required

Unique identifier for the organization

Example:

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

​
websiteId
string
required

Unique identifier for the website

Example:

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

​
imageUrl
string | null
required

URL of the image

Example:

"https://assets.snagsolutions.io/images/loyalty.png"

​
name
string
required

Name of the loyalty currency

Example:

"Loyalty Points"

​
symbol
string
required

Symbol representing the loyalty currency

Example:

"LP"

​
decimals
number
required

Number of decimal places for the currency

Required range: x >= 0
Example:

2

​
createdById
string | null
required

ID of the user who created the currency

Example:

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

​
createdAt
string
required

Timestamp when the currency was created

Example:

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

​
updatedAt
string
required

Timestamp when the currency was last updated

Example:

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

​
apiGetUrl
string | null
required

API GET URL for fetching data

Example:

"https://api.example.com/get-loyalty"

​
apiGetTransactionEntryUrl
string | null
required

API GET URL for fetching transaction entry data

Example:

"https://api.example.com/get-loyalty"

​
apiPostUrl
string | null
required

API POST URL for sending data

Example:

"https://api.example.com/post-loyalty"

​
apiAuthType
enum<string> | null
required

Type of authentication used for API

Available options:
none,
basic,
bearer,
apiKey
Example:

"basic"

​
apiAuthKey
string | null
required

Authentication key for API

Example:

"apiKey123"

​
apiAuthValue
string | null
required

Authentication value for API

Example:

"apiValue456"

​
sortId
number | null
required

Sorting identifier

Example:

1

​
deletedAt
string | null
required

Timestamp when the currency was deleted, if applicable

Example:

null

Was this page helpful?