Get the barcode collection
/api/v1/barcodes/collection
{basePath}/barcodes/collection?OrgShortName=tfoinc&LocRef=fdmnh144&RvcRef=42
Get barcodes configuration for menu item.Supported only for STS Gen2 cloud integrations.
Request
- application/json
-
locRef(required): string
The location identifier.
-
orgShortName(required): string
The organization identifier.
-
rvcRef(required): integer
The revenue center identifier.
-
If-Modified-Since: string
Standard http caching header (http caching link).
-
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
-
Last-Modified: string
A timestamp indicating the date and time at which the origin server believes the selected representation was last modified. See RFC 7232 Section 2.2
object-
BarcodeItem:
object BarcodeItem
-
OrgLocRvcProperties:
object OrgLocRvcProperties
A collection of properties for orgShortName, locRef and rvcRef
object-
locRef(required):
string
Location identifierExample:
store66 -
orgShortName(required):
string
Organization identifierExample:
mymeal -
rvcRef(required):
integer
Revenue Center identifierExample:
2
array-
Array of:
object BarcodeItem
Definition of a Barcode object
object-
barcode(required):
string
Minimum Length:
1Maximum Length:8192Pattern:^[0-9]+$The value of the barcodeExample:000123456890 -
barcodeId(required):
integer(int32)
Minimum Value:
1Identifier for the barcode item -
definitionSequence:
integer(int32)
Minimum Value:
1The menu item definition identifier for the barcode - menuItemId(required): integer(int32)
-
preparationCost:
number(float)
Minimum Value:
0Minimum Value:> trueThe alternate preparation cost for the barcode
If
minimum: 0
exclusiveMinimum: true
This means that the allowed values excludes the value of minimum, 0. So 0.000001 would be valid, but 0 would not.
If exclusiveMinimum: false then 0 and 0.000001 would be valid.
Zero price, preparationCost, definitionSequence or priceSequence are not allowed. -
price:
number(float)
Minimum Value:
0Minimum Value:> trueThe alternate price for the barcode
If
minimum: 0
exclusiveMinimum: true
This means that the allowed values excludes the value of minimum, 0. So 0.000001 would be valid, but 0 would not.
If exclusiveMinimum: false then 0 and 0.000001 would be valid.
Zero price, preparationCost, definitionSequence or priceSequence are not allowed. -
priceSequence:
integer(int32)
Minimum Value:
1The price sequence for the barcode
304 Response
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 Request Body
Not applicable for this endpoint.
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"orgShortName": "mymeal",
"locRef": "store66",
"rvcRef": 2,
"items": [
{
"barcodeId": 1,
"barcode": "000123456890",
"menuItemId": 32,
"definitionSequence": 1,
"price": 1,
"priceSequence": 1,
"preparationCost": 1
}
]
}