2020-08-26 Changelog

Employees API
Labor API
Orders API
Link to section

Version summary

Link to section


Link to section

Existing API updates

  • Orders API

    • Order object. The total_tip_money field is now GA.
    • CreateOrder, UpdateOrder, and BatchRetrieveOrders. These APIs now support merchant-scoped endpoints (for example, the CreateOrder endpoint POST /v2/orders). The location-scoped variants of these endpoints (for example, the CreateOrder endpoint POST /v2/locations/{location_id}/orders) continue to work, but these endpoints are now deprecated. You should use the merchant-scoped endpoints (you provide the location information in the request body).
  • Labor API

    • Migrate from Employees to Team Members. The Employees API is now deprecated in this release. Accordingly, update references to the Shift.employee_id field to the Shift.team_member_id field of the Labor API.
  • v2 Employees API (deprecated)

  • v1 Employees API (deprecated)

  • v1 Reporting API is retired.

Link to section

All SDKs

SDK technical reference documentation:

  • Nulls in SDK documentation example code are replaced with example values.
Link to section


Bug fixes:

  • The APIException.Errors property was not set on instantiation. Behavior is now corrected to instantiate the class with an empty Errors list.