Skip to main content

28 posts tagged with "api"

View All Tags

API September 2024 improvements

Sam Critchley
Co-Founder
  • Improved - added campaign active from/until date to voucher analytics
  • Improved - allow admin and end-user access to get-businesses endpoint
  • Improved - enable rewards creation via add-user-purchase-progress for Item Purchase Count campaign and other non-wallets
  • Improved - make chain_id optional in get-businesses as it's only needed for admin authentication
  • Fixed - fixed issue calculating previous balance in some circumstances in add-user-purchase-progress
  • Fixed - issue with BasketCampaign fixed_monetary_discount and add-basket when item_original_price is missing.

API August 2024 improvements

Sam Critchley
Co-Founder
  • Added - added Fixed Unit basket voucher and fixed_unit_basket_voucher reward method to campaign award which provides a fixed monetary discount per purchase unit of a matching item
  • Added - added content zones functionality and alter-content-page and get-content-page API endpoints to API
  • Improved - added totalvalue transaction message parameter
  • Improved - adjusted win spread for competition campaigns relative to budget to avoid win clustering
  • Improved - changed default Purchase Count logic to not include baskets purchased before campaign live date
  • Improved - extended add-user-purchase-progress endpoint to allow adding Progress and Item Purchase Count campaign amounts
  • Improved - improve min_earn_quantity logic for Matching Item campaign
  • Improved - make budget_period_quantity nullable in competition campaign
  • Improved - use campaign voucher text field for voucher text when creating competition vouchers
  • Fixed - fixed issue where it was possible for one competition budget period parameter to be null
  • Fixed - fixed issue where wrong returned basket item field was indexed leading to erroneous analytics data for returns
  • Fixed - fixed issue with BasketCampaign fixed_monetary_discount and add-basket when item_original_price is missing
  • Fixed - fixed issue with recurrence logic in purchase count campaign

API July 2024 improvements

Sam Critchley
Co-Founder
  • Added - added quantity_unit promotion type to basket campaigns - single unit monetary discount
  • Added - added business_format and business_region as campaign assignments
  • Added - added campaign minimum_matching_item_value to basket and other campaigns
  • Added - added end-user signature storage
  • Improved - allow PurchaseCount campaign to define the number of times a customer can be rewarded
  • Improved - campaign assignments exclude option now only applies to barcode assignments
  • Fixed - fixed bug in competition campaign award calculation and returns

API June 2024 improvements (1.5.3)

Sam Critchley
Co-Founder
  • Added - entries wallets for competitions
  • Improved - made chain_id parameter as mandatory with admin authentication in claim-voucher and unclaim-voucher endpoints for requests >= 1.5.3
  • Improved - extended Competition campaign functionality by adding budget and budget-based probability calculation
  • Improved - added call processing queuing to assigning a member_number in MyPrice App
  • Improved - added a minimum basket value for instant win competitions
  • Improved - added business_region and business_format as campaign assignment fields
  • Improved - added entryreference variable to transaction messages
  • Improved - added new user identifiers to claim-voucher and unclaim-voucher
  • Improved - added segment checking to birthday campaign issue script
  • Improved - added several variables to transaction messages: firstname, itemsneeded, value, eligibleitems
  • Improved - added total count to get-businesses response
  • Improved - allow increased competition budget amounts
  • Improved - competition campaigns decide whether to award wins based on supplied basket timestamp rather than processing timestamp
  • Improved - extended matching item campaign to issue points on value of basket if a basket contains a defined number of matching items
  • Improved - extended user-wallet-ledger to include branch business ID in the response
  • Improved - improved admin user authentication permissions-checking and input validation
  • Improved - improved user/customer synchronisation with Garden Connect API
  • Improved - removed member_number from user on obfuscation
  • Improved - removed redundant user eligibility check from event handling in birthday campaign
  • Improved - the way in which creating a dummy email address works
  • Fixed - edge-case in promotional basket reward calculation
  • Fixed - rounding issue in BasketCampaign
  • Fixed - issue with promotions display for wallet and points wallet
  • Fixed - parameter name issue when searching for businesses
  • Fixed - issue where user's dummy email address could be changed inadvertently
  • Fixed - reintroduced missing log_message in user_purchase_progress points and wallet ledger entries and notifications
  • Fixed - stop returning unredeemed competition vouchers in response to get-basket-price

API May 2024 improvements (1.5.2)

Sam Critchley
Co-Founder
  • Added competition campaigns and functionality
  • Added claim-vouchers endpoint to allow claiming (and optional locking) of multiple vouchers in a single call
  • Added new business endpoints get-business, get-businesses, delete-business
  • Users can now be created in add-user without requiring an email address or any other parameters
  • Added third party id to voucher object when chain configuration is set to allow third party id
  • Added default 400 HTTP response code for certain older API errors when request version is >= 1.5.2
  • Added template-based transaction messages to created vouchers and purchase progress in get-basket-price and add-basket responses
  • Restricted the implementation of dummy email addresses when a username value of null is passed in alter-user, so that this only happens in requests with a version \>= 1.5.2
  • Garden Connect/Green Solutions integration now supports adding users with password

API March 2024 improvements (1.5.1)

Sam Critchley
Co-Founder
  • Google and Apple wallet integration for showing membership passes
  • Allow an end user to request to update their own password
  • "Favorite Store" - added functionality calculating and returning a user's favorite store in API endpoints, based on their recent purchase history
  • "ARTS POSlog" - added functionality to import ARTS (Association for Retail Technology Standards) POSlog transaction files into the Spaaza system
  • Added cost price functionality to basket items in get-basket-price and add-basket endpoints in order to allow profit margin calculations and analytics sliced by various parameters such as store, product, user segment etc
  • Standardised custom headers to use X-Spaaza- prefix
  • Services API now returns standardised error codes and messages
  • Upgraded unit price rounding to max 4 decimal places in basket items and receipt line items in get-basket-price, add-basket and ARTS POSLog endpoints endpoints
  • Added authentication_point_identifier as a parameter in get-user-vouchers endpoint

API December 2023 improvements (1.5.0)

Sam Critchley
Co-Founder
  • "Business Groups" - features to group chain branches and introduce the concept of a user belonging to a business group, which can be used as a region and based on user location, and used to target campaigns.
  • "Meal Deal Promotions" - promotional campaigns allowing grouping of campaign assignments, and redemption in basket calls
  • "Client-Led promotions" - allow basket API endpoint clients (e.g. a POS or e-commerce) to define which promotions are applied to items in a basket, rather than requiring a call to get-basket-price to do that
  • "Fixed Monetary Discount" - promotional campaigns allowing a fixed monetary discount to be applied to each matching item in a basket
  • Various performance improvements, bug fixes and deprecation notices

API May 2023 improvements (1.4.8)

Sam Critchley
Co-Founder
  • The purchase_progress section of the response to get-basket-price and add-basket now includes an array of objects - one for each active wallet or progress campaign. Each object contains general wallet or progress campaign information, the previous and new balance for the customer, and an array of individual mutations. This allows API clients to build a full picture for inclusion in e.g. receipts.
  • The response to get-basket-price and add-basket now includes a voucher_created section describing vouchers which may have (provisionally) been created as a result of a transaction.