Changelog
This topic records notable changes to custom site features and related APIs, SDKs, and documentation.
| Change date | Change summary |
|---|---|
| 04-11-2025 | Clarified default and optional for schema |
| 04-03-2025 | Added id to locations on the item resource & removed loyalty_account_id from the rewards on the cart resource |
| 04-02-2025 | Added category_type to the category resource |
| 03-31-2025 | Added seo and social to bootstrapped site data |
| 03-19-2025 | Updated modifier docs to reflect the availability of the ChoiceSelection object |
| 03-11-2025 | Added id to the category resource and removed requirement of using the square_online_id filter for category IDs |
| 02-05-2025 | Added available_reward_tiers and upcoming_reward_tiers to the LoyaltyAccount on the CustomerAccount resource |
| 01-29-2025 | Added display_order to the modifier_lists for an Item resource |
| 01-14-2025 | Updated Breaking Changes with Localization |
| 01-08-2025 | Updated Breaking Changes with Remove category availability time add/subtract filters |
| 01-07-2025 | Add allow_order_item_quantities property to item resource. |
| 12-16-2024 | Link Resource is given the newTab property. Link Chooser control now updates the newTab property on a Link resource. |
| 12-12-2024 | Add the consent_purpose function |
| 12-10-2024 | Added resources function to support loading multiple resources in parallel |
| 12-06-2024 | Added the format_phone_number filter |
| 12-04-2024 | Added setPastTimeToCurrent to update the fulfillment time to ASAP if the requested fulfillment time is in the past. |
| 11-20-2024 | Added supported_image_sizes function |
| 11-05-2024 | Added expiration_policy to the loyalty program resource |
| 11-05-2024 | Deprecated the bootstrapped store resource, please see LINK for more details |
| 10-25-2024 | Added clear to the cart SDK helpers. |
| 10-24-2024 | Updated the orders[].id field in the customer-account resource to be the Square Order ID. |
| 10-24-2024 | Updated the home demo-site url from Kombu to Brisk. |
| 10-17-2024 | Added rewards to the cart resource order and variation_id to the cart resource order’s line_items. |
| 10-17-2024 | Added store-info resource and store_info resource function. |
| 10-10-2024 | Added color_contrast_ratio, color_lighten, color_luminance, and json_decode. |
| 10-10-2024 | Updated documentation for adjust, darken, contrast, neutral, alpha, and is_dark. |
| 10-08-2024 | Added only_subscribable to the item resource. |
| 10-03-2024 | Removed access to cookies from the request global context and request_data in a page JSON. |
| 09-27-2024 | Add documentation for new toggle hovertip property. |
| 09-05-2024 | Add documentation for new input control prefix and suffix props. |
| 09-04-2024 | Added documentation for option-cards control, and added documentation for adding custom icons to sections, global sections, section containers, and global section containers. |
| 09-03-2024 | Temporarily remove references to instagram-list |
| 08-15-2024 | Add render_mode flag for dashboard |
| 07-19-2024 | Add cart_errors to the cart resource and cart APIs |
| 07-16-2024 | Enabled global_settings function to do self-referencing. |
| 07-11-2024 | Updated the image and video resources to automatically process URLs, eliminating the need to manually use the asset_url Twig filter. |
| 07-11-2024 | Updated documentation for adding a new custom code page using the default_template defined in manifest.html.twig. |
| 07-04-2024 | Added new controls, stepper, global-panel-link and button-reset. |
| 06-26-2024 | Added the cart_data field to the cart API response. |
| 06-17-2024 | Added the render_mode flag to template parameters to signify the rendering context of the page. The render_mode can be editor, preview, or published |
| 06-14-2024 | Added missing properties around item options to Item resources |
| 06-11-2024 | Added the ability to attach loyalty rewards to a cart (see Cart API in the Site Theme SDK Reference and Client API Reference) |
| 05-31-2024 | Added the ability to use twig rendering in the page schemas (see Page Templates in the Page Rendering Guide) |
| 05-28-2024 | Added global_selected_style, global_selected_style_color, and global_selected_style_system_color filters |
| 05-20-2024 | Added inject_registered_asset function |
| 05-16-2024 | Fixed subtotal_money on the Cart resource to reflect discounts, and added subtotal_before_discounts_money to reflect the subtotal before discounts |
| 04-23-2024 | Added additional clarification for template API usage of request_data, and usage of request global context in the Site Directory guide |
| 04-19-2024 | Added is_advanced_notice to Item resources |
| 04-17-2024 | Added pagination.page to list resources, additional meta.paginate to list resources via the API, and a new paginate_meta function |
| 04-16-2024 | Updated cookie-based-redirect doc for all_paths config and enabled config |
| 04-10-2024 | Updated Breaking Changes with Resource API to Resources API |
| 04-04-2024 | Added theme performance guide |
| 04-04-2024 | Add route to available properties in request_data covered in Site Directory |
| 04-03-2024 | Updated Breaking Changes with Square Online Web SDK rename to Site Theme SDK |
| 03-28-2024 | System pages no longer provide default resources, you must now specify these resources yourself. See system pages documentation |
| 03-25-2024 | Added migration path note for the SDK in Breaking Changes’ Resource product to item property renames |
| 03-25-2024 | Added deprecation date in Breaking Changes to Patch to Put Fulfillment, LocationCourierQuotes to LocationCourierQuoteList, Resource product to item property renames, and Rename "option" to "control" in editor config |
| 03-22-2024 | Updated resources with breaking changes from Resource percentages, customer account ID string, and item subscription account rename |
| 03-21-2024 | Updated Breaking Changes with Resource percentages, customer account ID string, and item subscription account rename |
| 03-15-2024 | Updated resource documentation with breaking changes from Resource IDs |
| 03-13-2024 | Updated Breaking Changes with Item Subscription Discounts |
| 03-13-2024 | Updated Cart ScheduledValidation with new error property, and updated SDK Add Item guide with scheduled validation on the return value |
| 03-11-2024 | Updated SDK with new Money helper convertSubunitsToFloat |
| 03-11-2024 | Added is_alcoholic flag to the Cart resource’s line_items |
| 03-07-2024 | Temporarily remove references to story |
| 03-07-2024 | Update Breaking Changes with Resource IDs |
| 03-06-2024 | Update Breaking Changes with Resource product to item property renames |
| 03-06-2024 | Update Breaking Changes with LocationCourierQuotes to LocationCourierQuoteList |
| 03-06-2024 | Update Breaking Changes with Patch to Put Fulfillment |
| 03-04-2024 | Update Category and CategoryList resources with notice about the embedded items limit |
| 03-01-2024 | Added LocationCourierQuotes resource |
| 02-29-2024 | Added additional properties address.formatted and address.multiline_formatted to the Location resource |
| 02-28-2024 | Updated CategoryOptions resource with removal of properties that had been previously removed but not updated in the documentation |
| 02-27-2024 | Added format_price filter to filters |
| 02-27-2024 | Updated Cart, Category, CategoryList, CustomerAccount, DiscountList, Item, ItemList, Location, LocationList, LoyaltyProgram, ScheduleDays, and ScheduleTimes resources, and removed Schedule following 02/27/2024 Breaking Changes deployment |
| 02-26-2024 | Added Twig Filters to Breaking Changes with price filter changes |
| 02-23-2024 | Updated SDK with Money helpers and changes to Item Helpers’ Item Price guide in preparation for the Money Breaking Changes |
| 02-22-2024 | Updated Breaking Changes with Money clarification |
| 02-22-2024 | Updated Breaking Changes with removal of breaking change on the Item modifier lists |
| 02-21-2024 | Updated Breaking Changes Resources deploy date to be 02/27/2024 |
| 02-21-2024 | Updated Breaking Changes with Location fee fixes around money |
| 02-21-2024 | Added CustomerAccount resource to Breaking Changes |
| 02-16-2024 | Added category-square-online-id requirement to Breaking Changes |
| 02-16-2024 | Added async function removal to Breaking Changes |
| 02-16-2024 | Updated Breaking Changes with durations, Item modifier lists, and Schedule |
| 02-15-2024 | Added missing documentation about the Page JSON password protection |
| 02-15-2024 | Updated Breaking Changes section with Cart time properties |
| 02-15-2024 | Updated Breaking Changes section with Schedule deprecation |
| 02-15-2024 | Add loyalty_program resource function |
| 02-14-2024 | Updated Breaking Changes section with money |
| 02-14-2024 | Add additional bootstrap data to support Afterpay usage |
| 02-13-2024 | Added new controls, notice, checkbox, button-group, slider, color-chooser, select and video-chooser, as well as video resource docs and function. |
| 02-13-2024 | Added Breaking Changes section including initial resources subsection |
| 02-13-2024 | Added additional properties to the Cart resource’s line_items’ modifiers |
| 02-13-2024 | Add modifier properties that were missing from the item resource documentation |
| 02-07-2024 | Clarify resource API error handling. See Resource API |
| 02-06-2024 | Add wrapper around all sections, see Section templates |
| 02-02-2024 | Update Cart resource with SCHEDULED additions including validation |
| 02-02-2024 | Removed patchAsapPickupTime from the SDK with ASAP logic now occurring on the back end |
| 02-02-2024 | Add SCHEDULED fulfillmentType support for PICKUP and DELIVERY |
| 02-01-2024 | Updated Money to use amount (previously float_amount, now converted to a number) and amount_subunits (previously amount) |
| 01-31-2024 | Added link resource |
| 01-30-2024 | Added image resource |
| 01-30-2024 | Updated the cart resource to be up to date with latest changes |
| 01-30-2024 | Added getOrder method on a new Orders API to support fetching detailed past information useful for repeating a past transaction. |
| 01-24-2024 | Made changes to Money type to provide consistent fields across resources |
| 01-24-2024 | Updated prep_time_duration to be an object on an item resource (removing prep_time_duration_iso8601) to be consistent with schedule-times and schedule-days |
| 01-24-2024 | Added DELIVERY support to the SDK |
| 01-23-2024 | Added loyalty-program resource type and loyalty-account details to the customer-account resource |
| 01-19-2024 | Removed support for the customer_accounts_login tag and added support for the function customer_accounts_login(). Customer login is now restricted to inclusion of a pre-authored login flow. |
| 01-18-2024 | Added schedule-times and schedule-days resources with schedule to be deprecated and removed |
| 01-18-2024 | Remove pickup.prep_time in favor of prep_time_duration and prep_time_duration_iso8601 on an item resource |
| 01-17-2024 | Updated PATCH fulfillment API docs to include location ID |
| 01-17-2024 | Added more verbose cart API docs. Added Delivery fulfillment support in docs. Moved Delivery, Time-based categories, Blogs, and Subscriptions to supported features. |
| 01-11-2024 | Add support for overriding 404 and 500 pages |
| 01-09-2024 | Add support for in editor controls |
| 01-09-2024 | Restored customer-account resource |
| 01-03-2024 | Changed timezone property from string to object on location resource type |
| 01-03-2024 | Updated the options, variations, and modifiers sections in the How to: Display Items guide |
| 12-19-2023 | Adds support for passing UNIX timestamps to time filters |
| 12-19-2023 | Adds instagram-list resource type |
| 12-08-2023 | Updates Brisk to version 0.2.0-alpha. Changes in this version here |
| 12-05-2023 | Adds support for has_categories filter on item-list resource |
| 12-05-2023 | In our ongoing commitment to ensuring the highest standards of security for our both our users and 3P developers, we have decided to reevaluate and refine our approach to customizing the customer accounts page. As a part of this initiative, we will be removing the Customer Accounts resource. |
| 11-29-2023 | Removes default_item_fulfillment from store data |
| 11-29-2023 | Adds support for store locator system page |
| 11-18-2023 | Updates Brisk to version 0.1.0-alpha. Changes in this Version here |
| 11-14-2023 | Adds resource_type to all queryable resources. category-option.type renamed to option_type |
| 11-09-2023 | Add support for customer account system page |
| 11-08-2023 | Ask devs to supply User ID instead of Site ID |
| 11-06-2023 | Initial availability |