2021-12-15 Changelog

Square Invoices API Catalog API Cards API

Version Summary

• Square Version: 2021-12-15
• Java: 18.0.0.20211215
• .NET: 17.0.0
• Node.js: 17.0.0
• PHP: 17.0.0.20211215
• Python: 17.0.0.20211215
• Ruby: 17.0.0.20211215

Details

Link to section

API updates

• Invoices API:

  • The Invoices API now supports seller accounts in France. For more information, see International availability and considerations.

  • France only: Invoice object. Added a new payment_conditions field, which contains payment terms and conditions that are displayed on the invoice. This field is available only for sellers in France. For more information, see Payment conditions field.

    Square version 2021-12-15 or later is required to set this field, but it is returned in ListInvoices and RetrieveInvoice requests for all Square versions.

• Cards API:

  • Added the CARD_DECLINED_VERIFICATION_REQUIRED error code to the list of error codes returned by CreateCard.

• Catalog API:

  • CreateCatalogImage endpoint:

    • Updated the endpoint to support attaching multiple images to a CatalogObject instance.

    • Added the is_primary option to let the caller choose to attach an image as the primary image on the object for display with the Square Point of Sale application and other first-party Square products. For more information, see Upload and Attach Images.

  • CatalogObject object:

    • Retired the image_id field (used to hold a single image object attached to an image-supporting object of the ITEM, ITEM_VARIATION, CATEGORY, or MODIFIER_LIST type) in Square API version 2021-12-15 and later, which supports the attachment of multiple images. The image_id field is still supported in Square API versions prior to 2021-12-15. For more information, see Work with Images: Overview.

  • CatalogItem, CatalogItemVariation, CatalogCategory, or CatalogModifierList object:

    • Added the image_ids list to hold IDs of the attached image objects. The first element of the image_ids list refers to the primary image attached to the catalog object. For more information, see Work with Images: Overview.

  • UpdateCatalogImage endpoint:

    • Added the endpoint to support replacing the image file encapsulated by an existing CatalogImage object. For more information, see Replace the image file of a CatalogImage object.

  • CatalogPricingRule object:

    • Added the minimum_order_subtotal_money field to require that the minimum order subtotal be reached before the pricing rule can be applied.

Link to section

Documentation updates

• Developer Tools. Added this top-level node. This node describes tools such as the Sandbox, API Logs, and Webhooks.