- Square Version:
CreateOrder. Removed the
location_idfield from the request. It was an unused field.
v1 Items API:
The following endpoints are retired:
CreateTimecard: Use the Square Labor API CreateShift endpoint.
DeleteTimecard: Use the Square Labor API DeleteShift endpoint.
ListTimecards: Use the Square Labor API SearchShifts endpoint.
RetrieveTimecards: Use the Square Labor API GetShift endpoint.
UpdateTimecard: Use the Square Labor API UpdateShift endpoint.
ListTimecardEvents: No direct replacement. To learn about replacing the v1 functionality, see the migration guide.
All Square SDKs:
By default, all SDKs send requests to Square's production (https://connect.squareup.com) or sandbox (https://connect.squareupsandbox.com) hosts based on the client's
You now have the option to use a custom URL instead. To use a custom URL, follow the example for your language to set the
customUrlparameter to your URL:
Square .NET SDK:
Square has overridden the
GetHashCodemethods for models:
Equalsoverride, Square has implemented a field-level comparison.
GetHashCodeoverride now ensures that hashes are deterministic and unique for each object.
Square Node.js SDK:
Endpoints that return 64-bit integers now return a
BigIntobject instead of a
Connect Node.js SDK: (deprecated)
The deprecated Connect Node.js SDK is in the security maintenance state. It will not receive any bug fixes or API updates from the Square version 2021-02-26 release. However, the SDK will receive support and security patches until it is retired (end of life) in the second quarter of 2021. For more information, including steps for migrating to the Square Node.js SDK, see the Connect SDK README.
Update Catalog Objects. Provides programming guidance to update catalog objects.
List or retrieve inventory. Migrate the retired v1 endpoint of
ListInventoryto the v2 endpoint of
BatchRetrieveInventoryCounts. Compare and contrast the programming patterns between the v1 endpoint of
ListInventoryand its v2 counterparts of BatchRetrieveInventoryCounts or RetrieveInventoryCount.
Adjust or change inventory. Migrate the retired v1 endpoint of
AdjustInventoryto the v2 endpoint of
BatchChangeInventory. Compare and contrast the programming patterns between the v1 endpoint of
AdjustInventoryand its v2 counterparts of BatchChangeInventory.
Get Started topic. Revised the Get Started experience. In addition to clarifications, it now includes the use of the Square Sandbox and API Explorer. These are the tools and environments developers use to explore Square APIs.