New restaurants API parameter and response value to identify archived restaurants

The /v1/restaurants/{restaurantGUID} endpoint of the restaurants API has a new includeArchived query parameter. You use the includeArchived parameter to control whether the endpoint will return information about a Toast platform restaurant that has been archived. The restaurants API General object includes a new archived value that indicates whether a restaurant is in the archived status.

Archiving a restaurant is functionally similar to deleting a restaurant from the Toast platform. Archiving restaurants is rare, and you do not need to actively check the status of restaurants to determine whether they are archived. An example reason for archiving a restaurant is that the restaurant was created in error. A Toast platform restaurant location that becomes inactive because it goes out of business or no longer uses the Toast platform is not archived. An inactive state for a restaurant is more common than the archived state.

By default, the /v1/restaurants/{restaurantGUID} endpoint returns an HTTP 404 Not Found response when you request information about an archived restaurant. Now when you set the includeArchived query parameter to true, the endpoint will return information about the archived restaurant.