2020-12-16 Changelog

Square Customers API Loyalty API Invoices API Orders API Catalog API Bookings API

Version Summary

• Square Version: 2020-12-16
• Java: 8.0.0.20201216
• .NET: 8.0.0
• Node.js: 8.0.0
• PHP: 8.0.0.20201216
• Python: 8.0.0.20201216
• Ruby: 8.0.0.20201216

Details

Link to section

Existing API updates

• Orders API:

  • OrderLineItemPricingBlocklists. You can explicitly specify taxes and discounts in an order or automatically apply preconfigured taxes and discounts to an order. In addition, you can now block applying these taxes and discounts to a specific OrderLineItem in an order. You add the pricing_blocklists attribute to individual line items and specify the blocked_discounts and blocked_taxes that you do not want to apply. For more information, see Apply Taxes and Discounts. For example walkthroughs, see Automatically Apply Discounts and Automatically Apply Taxes.

  • OrderPricingOptions. Previously, the pricing_options field in an order supported only auto_apply_discounts to enable the automatic application of preconfigured discounts. Now it also supports auto_apply_taxes to enable the automatic application of preconfigured taxes. For more information, see Automatically apply preconfigured catalog taxes or discounts.

  • OrderLineItemTax. It now includes the new auto_applied field. It indicates whether the tax was automatically applied using a preconfigured CatalogTax.

• Bookings API:

  • The CancelBooking endpoint supports canceling an accepted or pending booking.

  • The booking.created webhook event notifies when a new booking is created by calling the CreateBooking endpoint.

  • The booking.updated webhook event notifies when an existing booking is updated.

• Catalog API:

  • ListCatalog, RetrieveCatalogObject, and BatchRetrieveCatalogObjects now support the catalog_version filter to return catalog objects of the specified version.

• Customers API:

  • SearchCustomers endpoint. The email_address, group_ids, phone_number, and reference_id query filters are now generally available (GA).

  • The AddGroupToCustomer endpoint is now GA.

  • The RemoveGroupFromCustomer endpoint is now GA.

  • The Customer Groups API is now GA.

  • The Customer Segments API is now GA.

• Invoices API: (beta)

  • Invoice object. Added the custom_fields field, which contains up to two customer-facing, seller-defined fields to display on the invoice. For more information, see Custom fields.
    As part of this change, the following objects are added:

    • InvoiceCustomField object

    • InvoiceCustomFieldPlacement enum

  • InvoiceRequestMethod enum. Added the read-only CHARGE_BANK_ON_FILE value, which represents a bank transfer automatic payment method for a recurring invoice.

• Loyalty API: (beta)

  • LoyaltyProgramRewardTier object. The definition field in this type is deprecated and replaced by the new pricing_rule_reference field. You can use pricing_rule_reference fields to retrieve catalog objects that define the discount details for the reward tier. For more information, see Get discount details for a reward tier.
    As part of this change, the following objects are deprecated:

    • LoyaltyProgramRewardDefinition object

    • LoyaltyProgramRewardDefinitionScope enum

    • LoyaltyProgramRewardDefinitionType enum

Link to section

New SDK release

• Square Node.js SDK:

  The new Square Node.js SDK is now GA and replaces the deprecated Connect Node.js SDK. The Connect Node.js SDK entered the security maintenance phase on 2020-12-16. For migration information, see the Connect SDK README.

Link to section

Documentation updates

• Get Right-Sized Permissions with Down-Scoped OAuth Tokens. This new OAuth API topic shows how to get an additional reduced-scope OAuth token with a 24-hour expiration by using the refresh token from the Square account authorization OAuth flow.