v9.0.0

Summary

New endpoints

Integration API

generateLoyaltyCard | POST /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card

Management API

createBatchLoyaltyCards | POST /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards
createCouponsDeletionJob | POST /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs | Creates a coupon deletion job
disconnectCampaignStores | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/stores | Disconnect stores
exportCampaignStores | GET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export | Export stores
exportLoyaltyCards | GET /v1/loyalty_programs/{loyaltyProgramId}/cards/export | Export loyalty cards
importCampaignStores | POST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import | Import stores
oktaEventHandlerChallenge | GET /v1/provisioning/okta | Validate Okta API ownership
scimCreateUser | POST /v1/provisioning/scim/Users | Create SCIM user
scimDeleteUser | DELETE /v1/provisioning/scim/Users/{userId} | Delete SCIM user
scimGetResourceTypes | GET /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types
scimGetSchemas | GET /v1/provisioning/scim/Schemas | List supported SCIM schemas
scimGetServiceProviderConfig | GET /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration
scimGetUser | GET /v1/provisioning/scim/Users/{userId} | Get SCIM user
scimGetUsers | GET /v1/provisioning/scim/Users | List SCIM users
scimPatchUser | PATCH /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes
scimReplaceUserAttributes | PUT /v1/provisioning/scim/Users/{userId} | Update SCIM user

Changes

Management API

activateUserByEmail | POST /v1/users/activate | Enable user by email address
deactivateUserByEmail | POST /v1/users/deactivate | Disable user by email address

v8.0.0

Summary

New endpoints

Management API

• Activate user by email address
• Invite user from identity provider

Changes

The disabled and archived campaign states were added.

⚠️ Deprecation Notice

• The GET /v1/roles endpoint was deprecated. Please use the new one GET /v2/roles
• The GET /v1/roles/{roleId} endpoint was deprecated. Please use the new one GET /v2/roles/{roleId}

v7.0.0

Summary

New endpoints

Management API

• Create Achievements
• Get achievement
• List achievements
• Update achievement
• List customer achievements
• Export achievement customer data
• Delete achievement
• Invite User
• Resend Invitation Email
• Update user
• Deactivate user by email address
• Delete user
• Delete user by email address
• Update role
• Export audience members
• Import audience members
• List audience members
• List audience analytics
• Get campaign access group
• List campaign access groups

v6.0.1: update superagent

Merge pull request #34 from talon-one/sc-35535-update-superagent-depe…

…ndency-in-javascript

v6.0.1: update superagent

v6.0.0: Stores

Summary

New endpoints

Integration API

• List card's unused loyalty points
• List customer's unused loyalty points

Management API

• Export customers' tier data
• Activate or deactivate notification
• Create store
• Delete store
• Get store
• List stores
• Update store

Changes:

• Create strikethrough notification endpoint path was changed to /v1/applications/{applicationId}/catalogs/notifications/strikethrough

⚠️ Deprecation Notice

• The endpoint to create notification about campaign-related changes (POST /v1/applications/{applicationId}/notification_webhooks) was deprecated
• The endpoint to delete notification about campaign-related changes (DELETE /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}) was deprecated
• The endpoint to get notification about campaign-related changes (GET /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}) was deprecated
• The endpoint to list notifications about campaign-related changes (GET /v1/applications/{applicationId}/notification_webhooks) was deprecated
• The endpoint to update notification about campaign-related changes (PUT /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}) was deprecated

v5.0.1-rc: Loyalty tiers import & List catalog items

Summary

Management API

• Import customers into loyalty tiers
• List items in a catalog

⚠️ Deprecation Notice: Export customer loyalty balance to CSV endpoint

Please note that the Export customer loyalty balance to CSV endpoint is getting deprecated, please update your code to point at the new Export customer loyalty balances

v5.0.0: Reopen session endpoint, loyalty data integration endpoints and loyalty card management endpoints

Summary

Integration API

• Reopen customer session
• Get customer's loyalty points
• List customer's loyalty transactions
• Get card's point balances
• List card's transactions
• Link customer profile to card

Management API

• Add points to card

• Deduct points from card

• Delete loyalty card

• List loyalty cards

• Get loyalty card

• Import loyalty cards

• Transfer card data

• Update loyalty card status

• List card's transactions

• List loyalty program transactions

• Export customer loyalty balances -- please note deprecation notice blow

• Export all card transaction logs

• Export card's ledger log

⚠️ Deprecation Notice: Export customer loyalty balance to CSV endpoint

Please note that the Export customer loyalty balance to CSV endpoint is getting deprecated, please update your code to point at the new Export customer loyalty balances

v4.6.0: Collection Items, Catalog Sync, Effects in getCustomerSession & Loyalty Transactions retrieval

v4.6.0

Collection Items, Catalog Sync, Effects in getCustomerSession & Loyalty Transactions retrieval

v4.5.0: Collections, EventsV2 & Partial Returns

TBD

v4.4.0: Customer Inventory Enhancements, Import Endpoints, Referral Updates & v1 integration endpoints deprecation

Summary

• Management API
  • Expose Import Endpoints
  • Introduce updateReferral Endpoint
  • Introduce exportReferrals Endpoint
• Integration API
  • Extended Customer Inventory Endpoint
  • Deprecation of Integration API@v1 endpoints

Management API

Expose import endpoints as integral part of the SDK

All of our CSV import endpoints are accessible via the Web Application from the corresponding entity pages (refer to our Help Center for an example regarding Coupons).

Now these are also available endpoints as part of the SDK (links to our developer docs):

• Coupons Import
• Referrals Import
• Loyalty Points Import
• Giveaway Codes Import

Example code snippet demonstrating import referrals using a CSV file:

// ...preparing api client...
// An example could be seen at the repository's README file: https://github.com/talon-one/talon_one.js#management-api
const fs = require('fs').promises

const referralsCSVFileContents = await fs.readFile('/path/to/import-referrals.csv')

const applicationId = 1
const campaignId = 2
const opts = {
  upFile: referralsCSVFileContents.toString()
}

apiInstance.importReferrals(applicationId, campaignId, opts).then(
  function(data) {
    console.log('Referrals imported successfully. Summary response:\n' + data);
  },
  function (error) {
    console.error("Error while importing referrals:\n" + error);
  }
);

☝️ Back to Table of Contents

Introduce updateReferral Endpoint

We introduced an endpoint to update referrals in order to allow updating their scheduling, usage limits and custom attributes attached to them.

Please consult the endpoint reference in our developer docs for more details.

☝️ Back to Table of Contents

Introduce ExportReferrals Endpoint

We introduced an endpoint to export referrals in an application or specific campaign as a CSV file.

Please consult the endpoint reference in our developer docs for more details and parameters.

☝️ Back to Table of Contents

Integration API

Extended Customer Inventory Endpoint

We have added a couple of useful data points to our customer inventory to make integration even simpler.

The customer inventory endpoint now has the ability to return giveaway codes that belong to the profile in query.
In order to learn more about setting up such campaigns refer to this help center article and this developer docs tutorial.

We have also extended the coupons objects that are returned as part of the inventory and attached these two useful data-points to each returned coupon:

• profileRedemptionCount - holds the number of times the coupon was redeemed by the profile
• state - holds the state of the coupon and can be one of the below values:
  • active: reserved coupons that are neither pending nor used nor expired, and have a non-exhausted limit counter
  • used: coupons that are not pending, and have reached their redemption limit or were redeemed by the profile before expiration
  • expired: all non-pending, non-active, non-used coupons that were not redeemed by the profile
  • pending: coupons that have a start date in the future

☝️ Back to Table of Contents

⚠️⚠️ Deprecation Notice: Integration API@v1 endpoints

Like we mentioned in the last few releases and months, from version 4.4.0 we won't include api@v1 endpoints as part of the official SDK.
The endpoints that are now deprecated are:

• Update a Customer Session (V1)
• Update a Customer Profile (V1)

If you don't use these as part of your integration, please discard this section.

We will not remove the endpoints, and they will still be accessible to use as part of older SDK versions or custom calls over http.

We highly encourage migrating to the correspondent v2 endpoints for easier and more granular integration, as well as new features support (See our developer docs section about migrating to API V2.0).

☝️ Back to Table of Contents