v8.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

v7.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}

v6.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

v5.0.0: Stores

Summary

New endpoints

Management API

• Create store
• Delete store
• Get store
• List stores
• Update store

⚠️ 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.0 Stores

Summary

New endpoints

Management API

• Create store
• Delete store
• Get store
• List stores
• Update store

⚠️ 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

v4.0.0: Track Event V2 endpoint, loyalty integration endpoint and loyalty, catalogs management endpoints

Summary

New endpoints

Integration API

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

Management API

• Export customers' tier data
• Export giveaway codes of a giveaway pool
• Import customers into loyalty tiers
• List items in a catalog
• Activate or deactivate notification
• Create notification about pending loyalty points

Changes:

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

⚠️ Deprecation Notice

The TrackEvent endpoint was deprecated. Please use the TrackEventV2 instead.

v3.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

⚠️⚠️ Migration to v3.0.0 from prior versions

As part of introducing and incorporating Cart Item Catalogs in the SDKs, we had to introduce some breaking changes to our CartItem model.

Please refer to this migration guide for a detailed explanation about the required changes.

⚠️ 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

v2.6.1: Fix malformed GetLoyaltyTransactions function response type

v2.6.1

• Fix malformed GetLoyaltyTransactions function response type (#20)

v2.6.0: Partial Returns, Collections & Improved customer inventory

v2.6.0

TBD

Issues closed

resolved #18

v2.5.0: Introduce referrals export endpoint and and Deprecate v1 integration endpoints

Summary

• Management API
  • Introduce ExportReferrals Endpoint
• Integration API
  • Deprecation of Integration API@v1 endpoints

Management API

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

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

Like we mentioned in the last few releases and months, from version 2.5.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 for you 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 API V2.0).

☝️ Back to Table of Contents