2023-12-13 Changelog

Catalog API:

Beta release of the new catalog categories model and object-retrieval/querying endpoints to support nested categories and multiple categories assigned to an item.

• CatalogItem object:

  • categories - New field to support assigning multiple categories to an item.
  • reporting_category - New field to support specifying the item's category for reporting or displaying purposes.
  • channels - New field to specify channels where the item is visible or available.
  • ecom_seo_data - New field to specify the SEO data for the seller's Square Online store.
  • category_id - Deprecated field to support backward compatibility for legacy applications to transition gracefully to multiple categories.

• CatalogCategory object:

  • category_type - New field to indicate a supported category type.
  • parent_category - New field to support nested categories.
  • is_top_level - New field to specify whether the category is a root category.
  • root_category - New field to specify the category's root.
  • channels - New field to specify the IDs of the channels in which to make the category visible.
  • availability_period_ids - New field to specify the category's availability periods.
  • online_visibility - New field to indicate whether the category is visible on the seller's Square Online sites.
  • ecom_seo_data - New field to represent the category's SEO data for a seller's Square Online store.
  • path_to_root - New field to specify the path from the category's immediate parent to its root category.

• CatalogObjectCategory - New object to reference a CatalogCategory instance by its ID value and positional order.

• SearchCatalogObjects, RetrieveCatalogObject and BatchRetrieveCatalogObjects endpoints - New include_category_path_root field added to the payload or as a query parameter to support returning the category's nesting path to the root.

Checkout API:

• Beta release of new endpoints that access and modify settings for payment links.
  • RetrieveMerchantSettings - Retrieves the merchant-level settings for a Square-hosted checkout page.
  • UpdateMerchantSettings - Updates the merchant-level settings for a Square-hosted checkout page.
  • RetrieveLocationSettings - Retrieves the location-level settings for a Square-hosted checkout page.
  • UpdateLocationSettings - Updates the location-level settings for a Square-hosted checkout page.

For more information, see Checkout Settings.

Terminal API

• DismissTerminalCheckout and DismissTerminalRefund endpoints. New endpoints that dismiss the "Please wait..." screen on a Square Terminal and transition to the idle screen.

App Marketplace

• Create an App Marketplace Listing - New documentation that provides best practices for writing an effective listing for your app in the App Marketplace.
• App Marketplace requirements topics - New interactive topics that ask questions about your API usage and provide a dynamic list of requirements tailored to your app.

Locations API:

• Expanded the list of Merchant Category Codes (MCCs) that can be provided to the UpdateLocation endpoint for each country and documented the MCCs available in Great Britain, France, Ireland, Spain, and Australia.

Terminal API:

• Dismiss Terminal Checkouts and Refunds - New documentation that describes how to dismiss Terminal checkouts and Interac refunds on a Square Terminal when the buyer needs to abandon a checkout or a refund operation.

Dev Essentials:

• Regional Differences for International Development - New information about regional payment processing differences.
• Compliance with Japan's Tax Invoice Preservation System - New information about meeting compliance with Japan's tax invoice preservation system.