2024-08-21 Changelog

• Catalog API - The following endpoint parameters, objects, properties, and enums are released to General Availability (GA).

  • Endpoint parameters - include_category_path_to_root in BatchRetrieveCatalogObjects, RetrieveCatalogObject, and SearchCatalogObjects
  • Objects - CatalogEcomSeoData and CategoryPathToRootNode
  • Properties:
    • CatalogCategory - category_Type, parent_Category, is_top_level, channels, availability_period_ids, online_visibility, root_category, ecom_seo_data, and path_to_root
    • CatalogItem - categories, channels, ecom_seo_data, and reporting_category
    • CatalogObject - availability_period_data
  • Enums - CatalogCategoryType

• Payments API:

  • Payment object - Added a new field that indicates timestamps for when a client device processes payments in Offline Mode:

    • client_created_at - Indicates the time on the device when the payment was taken offline. The offline_begin_time and offline_end_time filter options have been added to ListPayments to indicate the start and end time ranges for which to retrieve offline payments based on the client_created_at time in the payment object.

    For more information, see Payment location.

• Refunds API - Added support for cross-tender refunds to Square gift cards. This enables sending refunds from a payment source, such as card payments, to a gift card. For more information, see Refund Payments.

• Gift Cards API and Gift Card Activities API - Provided more information about how Refunds API integration works for refunds to gift cards. With the new Refunds API support for cross-tender refunds, Square now automatically activates new PENDING gift cards that are specified as the refund destination.
• Locations API - Added new Merchant Category Codes (MCCs) for businesses in Australia: 5812 (Restaurant/Bar) and 5813 (Bar/Club/Lounge).

Learn about versioning for the Square API and SDKs.