2022-04-20 Changelog

Square Catalog API Inventory API Orders API Payouts API Terminal API

Version Summary

• Square Version: 2022-04-20
• Java: 19.0.0.20220420
• .NET: 18.0.0
• Node.js: 18.0.0
• PHP: 18.0.0.20220420
• Python: 18.0.0.20220420
• Ruby: 19.0.0.20220420

Details

Link to section

New API releases

• Payouts API: (beta)

  • The Payouts API supports getting a list of deposits and withdrawals from a seller's bank accounts. This API replaces the legacy V1 Settlements API. For more information, see Payouts API Overview.

Link to section

API updates

• Catalog API:

  • BatchRetrieveCatalogObjects endpoint. Added the include_deleted_objects field to support returning deleted catalog objects.

  • CatalogModifier object. Added the image_ids field to support multiple images for a catalog modifier.

  • CatalogItemVariation object. Added the sellable field to indicate whether an item variation is sellable.

• Inventory API:

  • ItemVariationLocationOverrides object. Added the sold_out and sold_out_valid_until fields to support monitoring the sold-out status of an item variation in the inventory.

• Orders API:

  • OrderLineItemModifier object. Added the quantity field to support specifying a quantity for a line item modifier in an order. For more information, see Create Orders.

• Terminal API:

  • DeviceCheckoutOptions object. Added the collect_signature field to display the signature screen during a Terminal checkout. The Square Terminal T2 software must be version 5.13 or later to enable this option. This option is available only for US and Canada sellers.

Link to section

Documentation updates

• Square SDKs:

  • Node.js SDK. The SDK documentation is revised and now includes a quickstart and other details for developers to get started using the Square Node.js SDK.

  • Python SDK. The SDK documentation is revised and now includes a quickstart and other details for developers to get started using the Square Python SDK.

• Terminal API:

  • The Terminal API documentation is updated with steps to enable signature collection when taking a payment. For more information, see Take a payment with a signature.