2024-01-18 Changelog

Catalog API:

The Catalog API now supports new product types for CatalogItem with the following updates:

• CatalogItemProductType - Updated enum with additional fields of FOOD_AND_BEV, EVENT, DIGITAL, DONATION, LEGACY_SQUARE_ONLINE_SERVICE, and LEGACY_SQUARE_ONLINE_MEMBERSHIP.
• CatalogItem.food_and_beverage_details - New property to provide food and beverage details for an item of the FOOD_AND_BEV product type.
• CatalogItem.FoodAndBeverageDetails - New object to describe the food and beverage details of a FOOD_AND_BEV item.
• CatalogItem.FoodAndBeverageDetails.DietaryPreference - New object to describe the dietary preference as part of food and beverage details.
• CatalogItem.FoodAndBeverageDetails.DietaryPreference.DietaryPreferenceType - New enum for supported dietary preference types.
• CatalogItem.FoodAndBeverageDetails.DietaryPreference.StandardDietaryPreference - New enum for standard dietary preference.
• CatalogItem.FoodAndBeverageDetails.Ingredient - New object to describe the ingredient as part of food and beverage details.
• CatalogItem.FoodAndBeverageDetails.Ingredient.StandardIngredient - New enum for standard ingredients.

For more information, see create a food and beverage item explicitly.

GraphQL:

• Square GraphQL queries now support the following Square graphs:
  • Cash Drawer Shifts (Alpha)
  • Gift Cards and Gift Card Activities (Alpha)
  • Labor (Alpha)
  • Loyalty (Alpha)

Invoices API:

• The Invoices API now allows you to create and delete invoice attachments and retrieve attachment metadata with the following updates:

  • CreateInvoiceAttachment endpoint - New endpoint used to upload a file as an invoice attachment.
  • DeleteInvoiceAttachment endpoint - New endpoint used to delete an invoice attachment.
  • InvoiceAttachment object - New object that represents attachment metadata, such as the file name, file type, timestamp of when the file was uploaded, and an MD5 hash of the file contents.
  • Invoice object - New attachments field that contains attachment metadata, represented as a list of up to 10 InvoiceAttachment objects. For all Square API versions, this field is now included in API responses and webhook notifications if the invoice has attachments.

  For more information, see Create or Delete Invoice Attachments.

Loyalty API:

• LoyaltyPromotion object - The maximum length of the name field is changed from 50 characters to 70 characters.

Orders API:

• OrderReturn object:
  • return_tips - New array of OrderReturnTip objects. Each array element represents a tip being returned for an order.
• OrderLineItem object:
  • gross_sales_money - For inclusive tax items in the US, Canada, and Japan, tax is deducted from gross_sales_money. For Europe and Australia, the inclusive tax remains as part of the gross sale calculation.

Customers API:

• Manage Customer Profiles - Removed details about setting the X-Clear-Null header when using null to clear fields in an UpdateCustomer request. This header is no longer required.

Dev Essentials:

• Regional Differences for International Development - Added information about product and feature availability by region.

Locations API:

• Locations API Overview - Removed details about setting the X-Clear-Null header when removing fields from a Location object. When updating a location, you can remove any non-read-only field by setting its value to null.

Technical Scenarios:

• New scenario-based documentation that describes how to build applications that satisfy seller requirements for various use cases.
  • Build a Tip Report - Sellers want to report on the tips earned by their team members in a given time period.
  • Split an Online Payment - Sellers want the ability to use orders to capture split payments when credit cards and gift cards are used.
  • Build a Sales Report - Sellers want to generate sales reports for items sold in a given time period.