- 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
2023-08-16 Changelog
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:
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.
- CatalogItem object - New
Gift Cards API:
- ListGiftCards endpoint - Increased the maximum
limit
value from 50 to 200. This change applies to all Square versions.
- ListGiftCards endpoint - Increased the maximum
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 replacespoints_multiplier
. - Deprecated the
points_multiplier
field. For more information, see Migration notes.
- Added the
- LoyaltyPromotionIncentivePointsMultiplierData object - The
Orders API:
- TenderType object - Added
BANK_ACCOUNT
,BUY_NOW_PAY_LATER
, andSQUARE_ACCOUNT
values. - Tender object - Added TenderBankAccountDetails, TenderBuyNowPayLaterDetails, and TenderSquareAccountDetails.
- TenderType object - Added
Payments API:
- Payment object:
- Added the
SQUARE_ACCOUNT
value tosource_type
. - Added the
square_account_details
field.
- Added the
- CreatePayment endpoint - Added the
customer_details
field to support customer-initiated and mail-order/telephone-order (MOTO) payments.
- Payment object:
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:
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.