Get the collection of unavailable menu items
/api/v1/menus/items/unavailable
items/unavailable?orgShortName=tfoinc&locRef= fdmnh144& rvcRef=42
Get a menu item availability status for menu items.Request
- application/json
-
locRef(required): string
The location identifier.
-
orgShortName(required): string
The organization identifier.
-
rvcRef(required): integer
The revenue center identifier.
-
If-None-Match: string
Standard http caching header (http caching link).
Response
- application/json
200 Response
-
ETag: string
The current entity-tag for the selected representation. See RFC 7232 Section 2.3
object-
locRef(required):
string
Location identifierExample:
store66 -
orgShortName(required):
string
Organization identifierExample:
mymeal -
rvcRef(required):
integer
Revenue Center identifierExample:
2
304 Response
-
ETag: string
The current entity-tag for the selected representation. See RFC 7232 Section 2.3
400 Response
object-
details:
string
A human-readable explanation specific to this occurrence of the problem.Example:
The OrgShortName value is required. -
instance:
string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.Example:
required_value_missing -
title:
string
A short, human-readable summary of the problem type.Example:
Required value not specified. -
type:
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
error:validation
{
"type":"error:validation",
"title":"Required value not specified.",
"details":"The OrgShortName value is required.",
"instance":"required_value_missing"
}401 Response
-
WWW-Authenticate: string
Bearer authentication challenge. When token validation fails, the header may include error and error_description parameters.
The following conditions and HTTP response examples are illustrative and not exhaustive. Error descriptions may vary.
No token provided: No access token is provided, or the Authorization request header is missing. The response header is WWW-Authenticate: Bearer, without error or error_description parameters.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: BearerExpired token: The access token has expired. The timestamp in this example is illustrative.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The token expired at '05/19/2026 17:16:29'"Signing key not found: The token cannot be validated because its signing key was not found. For example, the token's key ID (kid) does not match a key in the JSON Web Key Set (JWKS) used for validation.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature key was not found"Invalid signature: The token signature is invalid. For example, the token may have been modified.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature is invalid"For the missing-token, signing-key-not-found, and invalid-signature examples above, the response body is empty. The authentication error details are provided in the WWW-Authenticate response header.
The response may include an additional WWW-Authenticate header containing a bare Bearer challenge alongside the challenge shown in these examples.
Examples
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"orgShortName": "mymeal",
"locRef": "store66",
"rvcRef": 2,
"items": [
{
"menuItemId": 32,
"definitions": [
{
"definitionSequence": 1
}
]
}
]
}