v7.0.1

Summary

Allow 0 values for price, usageLimit and position

Integration API

• Update customer session
• Sync cart item catalog

Management API

• Create coupons

Full Changelog: v7.0.0...v7.0.1

v7.0.0

Summary

New endpoints

Integration API

• Generate Loyalty Card

Management API

• Create loyalty cards
• Export loyalty cards
• Creates a coupon deletion job
• Disconnect stores
• Export stores
• Import stores
• Validate Okta API ownership
• List SCIM users
• Create SCIM user
• Get SCIM user
• Delete SCIM user
• Update SCIM user
• Update SCIM user attributes
• List supported SCIM resource types
• Get SCIM service provider configuration
• List supported SCIM schemas

v6.0.0 Achievements

Summary

New endpoints

Integration API

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

Management API

• Create achievement
• Delete achievement
• Export achievement customer data
• Get achievement
• List customer achievements
• List achievements
• Update achievement
• Resend invitation email
• Invite user
• Deactivate user by email address
• Delete user
• Delete user by email address
• Update role
• Update user
• Create store
• Delete store
• Get store
• List stores
• Update store
• Export audience members
• List audience members
• List audience analytics
• Import audience members
• Export customers' tier data
• Get campaign access group
• List campaign access groups
• Activate or deactivate notification
• POST /v1/users/activate | Activate user by email address
• List roles
• Get role
• POST /v1/users/invite | Invite user from identity provider

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.2: Fix set EmitDefaultValue=true for UsageLimit

Summary

• Management API
  • Creating coupons with the C# SDK doesn't allow usageLimit = 0

Management API

Creating coupons with the C# SDK doesn't allow usageLimit = 0

We fixed a bug which does not allow creating a coupon with 0 usageLimit (unlimited redemptions)

☝️ Back to Table of Contents

v5.0.1: Fix Asynchronous calls authentication bug, introducing giveaways export, loyalty tiers import

Summary

Misc

• Fix bug that resulted in an authentication error when calling API functions via their asynchronous versions (i.e. GetApplicationAsync)

Management API

• Export giveaway codes of a giveaway pool
  
• Import customers into loyalty tiers
• List items in a catalog

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

Dependencies Upgrades

• Newtonsoft.Json: 12.0.1 -> 13.0.2; closes #25
• RestSharp: 106.10.1 -> 106.15.0; closes #16

Fix import endpoints bug with due to RestSharp's older version 🎉

Import endpoints are now functional.
Please note that the upFile argument that each endpoint expects is expected to hold the contents to be imported. It's the consumer's responsibility to read the csv file to be imported, or create a csv-string and send it as the upFile argument. Below is an example for importing loyalty points, provided a csv file holding the contents named loyalty-import.csv:

// initiate management api instance
// ...

string upFile = File.ReadAllText("/path/to/file/loyalty-import.csv");
int programID = 42;

var response = mgmtAPI.ImportLoyaltyPoints(programID, upFile);

closes #21

⚠️ 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.0.4: fix Position is ignored when set to 0 for `CartItem` / `ReturnedCartItem`

Summary

• Integration API
  • Fix zero-position ReturnedCartItems are ignored

Integration API

Fix zero-position ReturnedCartItems are ignored

We fixed a bug in which the Position field of CartItem models with a valid value of 0 are ignored and resulted in an error by the endpoint (#23)

☝️ Back to Table of Contents

v4.0.3: Partial Returns & Collections

TBD

v4.0.2: fix Price is ignored when set to 0 for CartItem / AdditionalCost

Summary

• Integration API
  • Fix zero-priced CartItems / AdditionalCosts are ignored

Integration API

Fix zero-priced CartItems / AdditionalCosts are ignored

We fixed a bug which prices with value 0 of cart items or additional to be ignored and resulted in an error by the endpoint (#19)

☝️ Back to Table of Contents

v4.0.1: Introduce export referrals 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 4.0.1 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