Skip to main content

API June 2025 improvements (1.5.7)

Sam Critchley
Co-Founder
  • Added - added add-note, get-notes, delete-note endpoints to manage Note objects (these endpoints are restricted to admin authentication)
  • Added - added get-content-pages and delete-content-page endpoints to manage content pages
  • Added - Added opt_in_secondary_last_modified_date to a user, which is a datetime field that records the last time opt_in_secondary date changed
  • Added - added non-payment error response to API to indicate when Spaaza customers are in payment default and cannot use the API
  • Added - it is now possible to configure an optional maximum_basket_total_value_spend in a campaign - a maximum basket total value for a reward to be redeemed in a basket
  • Added - it is now possible to configure an optional maximum_basket_total_value_earn in a campaign - a maximum basket total value for a reward to be earned
  • Added - the add-basket and get-basket-price endpoints can now override the campaign redemption grace period. By specifying a redemption grace period in a specific basket, the campaign's default grace period can be overridden
  • Added - the alter-chain and get-chain endpoints can now set a chain redemption grace period, which is the number of hours during which a campaign's vouchers can still be redeemed correctly after the active_date_until has passed
  • Added - user authentication against the Shopify API is now supported, allowing end-users to authenticate against the Shopify API using their Spaaza credentials, such as when using the Spaaza whitelabel mobile app
  • Added - issue a reward when a customer subscription renewal is received via a Stripe webhook
  • Improved — improved retry handling when making calls to external APIs such as Magento 2, Green Solutions and other providers
  • Improved - it is now possible to apply basket value restrictions (maximum_basket_total_value_spend and maximum_basket_total_value_earn) to matching item campaigns, allowing for more control over the redemption process
  • Improved - improvements in content page campaign handling
  • Improved - it is now possible to restrict redemption of a competition grand prize to the store in which the prize was issued
  • Improved - updates to IOS mobile pass wallet handling
  • Improved - completed Shopify API communication migration to Shopify GraphQL admin API
  • Improved - improvements to win distribution time algorithm for store-budgeted competition campaigns
  • Improved - performance improvements in competition budget checking when issuing instant win vouchers
  • Improved - webhook handling for Stripe subscription features
  • Improved - event pipeline performance improvements for wallet mutation events
  • Improved - locale (language) field is now synchronised between Spaaza user account and Shopify customer account, allowing for better localisation of content and campaigns
  • Improved - performance when user member number updates take place
  • Improved - issue-avoidance when processing simultaneous duplicate webhooks received from Shopify
  • Fixed - issues in Shopify account activation flow
  • Fixed - bug in matching non-product campaign assignments
  • Fixed - issue with missing title when creating Shopify discount code for wallet voucher
  • Fixed - issue with unhandled exception when no response is received from Green Solutions (formerly Garden Connect) API
  • Fixed - issue with voucher redemption after campaign active date has passed
  • Fixed - issue where wallet mutation event was not dispatched correctly when a customer used points to receive a reward
  • Deprecated - the user-specific notes field has been replaced by the new Note object in the add-note, get-notes and delete-note endpoints, which allows for more flexible and structured note management. The notes field will be removed from the response to the get-card endpoint in version 1.6.0.