2020-02-26 Changelog

Connect v1 Square Checkout API Orders API Customers API BankAccounts API Disputes API CashDrawerShifts API DEPRECATED BETA

Version Summary

• Square Version: 2020-02-26
• Java: 5.0.0.20200226
• .NET: 5.0.0
• Node.js: 3.20200226.0
• PHP: 3.20200226.0
• Python: 5.0.0.20200226
• Ruby: 5.0.0.20200226

Details

Link to section

API releases

• Disputes API (Beta)

  • For an overview, see Overview

  • For technical reference, see Disputes API.

• Bank Accounts API (GA)

  • For an overview, see Overview

  • For technical reference, see Bank Account

• CashDrawerShifts API (GA)

  • For an overview, see Use the Cash Drawer Shifts API

  • For a technical reference, see Cash Drawers

• New webhooks — Webhooks now supports webhooks for the Payments API, Disputes API, and Bank Accounts API. For more information, see Subscribe to Events.

Link to section

Existing API updates

• Catalog API

  • Batch upsert catalog objects endpoint — The batches field is now required and the array must have at least one element.

  • CatalogModifier — Two fields added:

    • ordinal to support custom ordering in a modifier list

    • modifier_list_id to reference the parent modifier list

  • CatalogModifierList — New field added: ordinal to support custom ordering in a list of CatalogModifierList objects.

• Customers API changes

  • SearchCustomers endpoint — limit size reduced from 1000 to 100 to improve the endpoint performance.

• Orders API changes

  • CreateOrderRequest — Previously these request fields were deprecated: line_items, taxes, discounts. These fields are no longer available. Instead you now use the Order object in the request. For example, Order.line_items, Order.taxes, and Order.discounts.

  • OrderLineItem type — There are two changes:

    • The taxes field that was previously deprecated is no longer available. Instead, you now use the OrderLineItem.applied_taxes field. This also now requires that you set the OrderLineItemTax.scope field.

    • The discounts field that was previously deprecated is no longer available. Instead, you now use the OrderLineItem.applied_discounts field. This also now requires that you set the OrderLineItemDiscount.scope field.

• Shared object updates

  • Card object — New fields added: card_type, prepaid_type. Currently, only the Payments API responses populate these fields.

Link to section

V1 Deprecations

The following V1 APIs are now deprecated:

• Cash Drawers API

  • For migrating to Square API, see Migrate from Connect v1 CashDrawerShifts API

  • For technical reference, see Cash Drawers

• Bank Accounts API

  • For migrating to Square API, see Migrate from Connect v1 BankAccounts API

  • For technical reference, see Bank Accounts

• Time Cards API

  • For migrating to Square API, see Migrate from Connect v1 Timecards API

  • For technical reference, see Time Cards