Version 5.3.0.20200528 (2020-05-28)

API releases

• Loyalty API (beta):
  • For an overview, see Loyalty Program Overview.
  • For technical reference, see Loyalty API.

Existing API updates

• Orders API

  • CalculateOrder (beta) endpoint. Use the endpoint to calculate adjustments (for example, taxes and discounts) to an order for preview purposes. In response, the endpoint returns the order showing the calculated totals. You can use this endpoint with an existing order or an order that has not been created.

  The endpoint does not update an existing order. It only returns a calculated view of the order that you provided in the request. To create or update an order, use the CreateOrder and UpdateOrder endpoints, respectively.

  • Order type. Two fields are added in support of the Loyalty API integration. For more information, see Deferred reward creation. For an example, see Redeem Points.
    • Order.rewards represents rewards added to an order by calling the CreateLoyaltyReward endpoint.
    • Order.discount.reward_ids indicates that a discount is the result of the specified rewards that were added to an order using the CreateLoyaltyReward endpoint.

• Customers API

  • The Search Customers endpoint supports search by email address, phone number, and reference ID with the following additional query filters:

    • The email_address query filter (beta) supports an exact or fuzzy search for customer profiles by their email addresses.

    • The phone_number query filter (beta) supports an exact or fuzzy search for customer profiles by their phone numbers.

    • The reference_id query filter (beta) supports an exact or fuzzy search for customer profiles by their reference IDs.

  • The created_at, updated_at, and id attributes on the Customer resource are updated to be optional. As a result, they no longer are required input parameters when you call the Square SDKs to create a Customer object. You might need to update the dependent SDKs to the latest version to mediate breaking your existing code.

Square Webhooks

• Square Webhooks (formerly v2 Webhooks). The status is changed from beta to general availability (GA).

• v1 Webhooks. The v1 Inventory and Timecards webooks are now deprecated and replaced by inventory.count.updated and labor.shift.updated.