Retrieve versions of price levels

Retrieve versions of price levels

Securityoauth2
Request
header Parameters
Content-Type
required
string <string>

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

Toast-Restaurant-External-ID
required
string <uuid>

The Toast platform identifier for the restaurant.

Request Body schema: application/json
required

A SearchCriteria object containing the search criteria to use when retrieving versions of price levels.

name
string

Contains a string. The menus edit API returns any price level version whose name contains this string. Strings must be 1 to 255 characters. The name value can be omitted or set to null but it cannot contain an empty string.

The targets array and the name value can be used together to retrieve price level versions whose targets match the IDs you specify in the targets array and whose names contain the strings specified in the name value. The menus edit API also returns price level versions for the ancestors of the targets you specify in the targets array and that have names that contain the name value.

If the name value is omitted or null and the targets value is omitted or empty, then the menus edit API returns all price level versions for the session restaurant and any of its ancestors in the location group hierarchy.

nextPageToken
string

For searches that have more than 500 results, this string identifies the following page of response data.

If the nextPageToken is omitted or set to null, the first page of results is returned.

Array of objects (Target)

Contains an array of Target objects. Each Target object contains a GUID for a location group or location. Use these objects to specify the targets you want to retrieve price level versions for. For example, to retrieve price levels versions used by the Boston location, enter the Boston location's GUID in a Target object and include it in the targets array.

The targets array can be be omitted or left empty.

The targets array and the name value can be used together to retrieve price level versions whose targets match the IDs you specify in the targets array and whose names contain the strings specified in the name value. The menus edit API also returns price level versions for the ancestors of the targets you specify in the targets array and that have names that contain the name value.

If the name value is omitted or null and the targets value is omitted or empty, then the menus edit API returns all price level versions for the session restaurant and any of its ancestors in the location group hierarchy.

Responses
200

Returns a PriceLevelVersions object. This object has a data value that is an array of PriceLevelVersion objects for the price level versions that match the search criteria.

400

One or more of the location group or location GUIDs passed in the SearchCriteria object are invalid.

422

The name value in the SearchCriteria object contains an empty string or exceeds 255 characters.

post/price-levels/search
Request samples
application/json
{
  • "name": "string",
  • "targets": [
    ],
  • "nextPageToken": "string"
}
Response samples
application/json
{
  • "nextPageToken": "string",
  • "data": [
    ]
}