v25.16.0

Summary

Added endpoints

• IntegrationApi | bestPriorPrice | POST /v1/best_prior_price | Fetch best prior price

Removed endpoints

• None

v25.15.0

Summary

Added endpoints

• createCampaignStoreBudget | POST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | Create campaign store budget
• deleteCampaignStoreBudgets | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | Delete campaign store budgets
• exportCampaignStoreBudgets | GET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/export | Export campaign store budgets
• importCampaignStoreBudget | POST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/import | Import campaign store budgets
• listCampaignStoreBudgetLimits | GET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | List campaign store budget limits
• scimCreateGroup | POST /v1/provisioning/scim/Groups | Create SCIM group
• scimDeleteGroup | DELETE /v1/provisioning/scim/Groups/{groupId} | Delete SCIM group
• scimGetGroup | GET /v1/provisioning/scim/Groups/{groupId} | Get SCIM group
• scimGetGroups | GET /v1/provisioning/scim/Groups | List SCIM groups
• scimPatchGroup | PATCH /v1/provisioning/scim/Groups/{groupId} | Update SCIM group attributes
• scimReplaceGroupAttributes | PUT /v1/provisioning/scim/Groups/{groupId} | Update SCIM group
• summarizeCampaignStoreBudget | GET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/summary | Get summary of campaign store budgets

Removed endpoints

• getWebhookActivationLogs | GET /v1/webhook_activation_logs | List webhook activation log entries
• getWebhookLogs | GET /v1/webhook_logs | List webhook log entries

v11.0.0

What's Changed

IntegrationApi

New endpoints

getCustomerAchievementHistory
GET /v1/customer_profiles/{integrationId}/achievements/{achievementId}
getCustomerAchievements
GET /v1/customer_profiles/{integrationId}/achievements

ManagementApi

New endpoints

getDashboardStatistics
GET /v1/loyalty_programs/{loyaltyProgramId}/dashboard
getMessageLogs
GET /v1/message_logs

Removed endpoints

notificationActivation
PUT /v1/notifications/{notificationId}/activation
postAddedDeductedPointsNotification
POST /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points
postCatalogsStrikethroughNotification
POST /v1/applications/{applicationId}/catalogs/notifications/strikethrough
postPendingPointsNotification
POST /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points

Full Changelog: v10.0.0...v12.0.0

v10.0.0

Summary

Removed endpoints

Management API

getAllAccessLogs

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.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
• Create store POST /v1/applications/{applicationId}/stores
• Delete store DELETE /v1/applications/{applicationId}/stores/{storeId}
• Get store GET /v1/applications/{applicationId}/stores/{storeId}
• List stores GET /v1/applications/{applicationId}/stores
• Update store PUT /v1/applications/{applicationId}/stores/{storeId}

Changes:

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

⚠️ Deprecation Notice

• The TrackEvent endpoint /v1/events was deprecated. Please use the TrackEventV2 instead /v2/events.
• 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.1.0: Fix PHP 8.1 incompatibility issues in SDK

What's Changed

• fix: PHP 8.1 incompatibility issues in SDK by @rubyjohn93 in #19

New Contributors

• @rubyjohn93 made their first contribution in #19

Full Changelog: v5.0.0...v5.1.0

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