2023-08-16 Changelog

Square Documentation Bookings API Booking Custom Attributes API Catalog API Gift Cards API Locations API Loyalty API Orders API Payments API DEPRECATED

Version Summary

• Square Version: 2023-08-16
• Java: 32.0.0.20230816
• .NET: 30.0.0
• Node.js: 30.0.0
• PHP: 30.0.0.20230816
• Python: 30.0.0.20230816
• Ruby: 31.0.0.20230816

Details

Link to section

API updates

• Bookings API:

  • BulkRetrieveBookings endpoint - New endpoint that supports the retrieval of multiple bookings in one call.

  • ListBookings endpoint - New customer_id field that supports the listing of bookings by customer ID.

• Bookings Custom Attributes API:

  • Booking Custom Attributes API - Moved to General Availability.

• Catalog API:

  • CatalogItem object - New is_archived field that indicates whether an item is archived (true) or not (false).

  • ArchivedState enum - New enum that supports searching for archived items, non-archived items, or both.

  • archived_state query filter - Added to the SearchCatalogItems endpoint to return archived items, non-archived items, or both.

• Gift Cards API:

  • ListGiftCards endpoint - Increased the maximum limit value from 50 to 200. This change applies to all Square versions.

• Locations API:

  • TaxIds object - Added the QII (Qualified Invoice Issuer) tax ID used for locations in Japan.

• Loyalty API:

  • LoyaltyPromotionIncentivePointsMultiplierData object - The POINTS_MULTIPLIER incentive type now supports decimal multipliers (for example, earn 1.5x points):

    • Added the multiplier field, which is a string representation of a decimal. This field replaces points_multiplier.

    • Deprecated the points_multiplier field. For more information, see Migration notes.

• Orders API:

  • TenderType object - Added BANK_ACCOUNT, BUY_NOW_PAY_LATER, and SQUARE_ACCOUNT values.

  • Tender object - Added TenderBankAccountDetails, TenderBuyNowPayLaterDetails, and TenderSquareAccountDetails.

• Payments API:

  • Payment object:

    • Added the SQUARE_ACCOUNT value to source_type.

    • Added the square_account_details field.

  • CreatePayment endpoint - Added the customer_details field to support customer-initiated and mail-order/telephone-order (MOTO) payments.

Link to section

Documentation updates

• Delete Catalog Objects and Query Deleted Objects - New topic that documents how to delete a catalog object and query deleted objects for auditing purposes.

• Reorganized the Gift Cards section of the documentation and added the following new topics:

  • Sell Square Gift Cards

  • Reload Square Gift Cards

  • Redeem Square Gift Cards

  • Retrieve Square Gift Cards and Track Activity

  • Manage Square Gift Cards on File

• House accounts allow customers to make purchases (up to a predetermined spending limit), and pay the seller for those purchases at a later date. You can use the Payments API to view house account charges, and the Orders API to view items charged to a house account. For more information, see House Accounts.