Simphony Transaction Services Gen2 API Guide

Get the barcode collection

get

/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

Supported Media Types

application/json

Query Parameters

LocRef(required): string

The location identifier. Will be forced to lower-case.
OrgShortName(required): string

The organization identifier. Will be forced to lower-case.
RvcRef(required): string

The revenue center identifier.

Header Parameters

If-Modified-Since: string

If-Modified-Since HTTP header
If-None-Match: string

If-None-Match HTTP header

Response

Supported Media Types

application/json

200 Response

A collection of barcodes

Headers

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

Root Schema : BarcodeCollection

Type: object

A collection of BarcodeItems for a revenue center

Show Source

BarcodeItem: object BarcodeItem
OrgLocRvcProperties: object OrgLocRvcProperties

A collection of properties for orgShortName, locRef and rvcRef

{
    "description":"A collection of BarcodeItems for a revenue center",
    "type":"object",
    "properties":{
        "OrgLocRvcProperties":{
            "$ref":"#/definitions/OrgLocRvcProperties"
        },
        "BarcodeItem":{
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/BarcodeItem"
                    }
                }
            }
        }
    }
}

Nested Schema : BarcodeItem

Type: object

Show Source

items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BarcodeItem"
            }
        }
    }
}

Nested Schema : OrgLocRvcProperties

Type: object

A collection of properties for orgShortName, locRef and rvcRef

Show Source

locRef(required): string

Location identifier

Example: store66
orgShortName(required): string

Organization identifier

Example: mymeal
rvcRef(required): integer

Revenue Center identifier

Example: 2

{
    "description":"A collection of properties for orgShortName, locRef and rvcRef\n",
    "type":"object",
    "required":[
        "orgShortName",
        "locRef",
        "rvcRef"
    ],
    "properties":{
        "orgShortName":{
            "description":"Organization identifier",
            "type":"string",
            "example":"mymeal"
        },
        "locRef":{
            "description":"Location identifier",
            "type":"string",
            "example":"store66"
        },
        "rvcRef":{
            "description":"Revenue Center identifier",
            "type":"integer",
            "example":2
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object BarcodeItem

Definition of a Barcode object

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BarcodeItem"
    }
}

Nested Schema : BarcodeItem

Type: object

Definition of a Barcode object

Show Source

barcode(required): string

Minimum Length: 1

Maximum Length: 8192

Pattern: ^[0-9]+$

The value of the barcode

Example: 000123456890
barcodeId(required): integer(int32)

Minimum Value: 1

Identifier for the barcode item
definitionSequence: integer(int32)

Minimum Value: 1

The menu item definition identifier for the barcode
menuItemId(required): integer(int32)

Minimum Value: 1

The menu item identifier for the barcode

Example: 32
preparationCost: number(float)

Minimum Value: 0

Minimum Value: > true

The 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: 0

Minimum Value: > true

The 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: 1

The price sequence for the barcode

{
    "description":"Definition of a Barcode object",
    "type":"object",
    "required":[
        "barcodeId",
        "barcode",
        "menuItemId"
    ],
    "properties":{
        "barcodeId":{
            "description":"Identifier for the barcode item",
            "type":"integer",
            "format":"int32",
            "minimum":1
        },
        "barcode":{
            "description":"The value of the barcode",
            "type":"string",
            "pattern":"^[0-9]+$",
            "minLength":1,
            "maxLength":8192,
            "example":"000123456890"
        },
        "menuItemId":{
            "description":"The menu item identifier for the barcode",
            "type":"integer",
            "format":"int32",
            "minimum":1,
            "example":32
        },
        "definitionSequence":{
            "description":"The menu item definition identifier for the barcode",
            "type":"integer",
            "format":"int32",
            "minimum":1
        },
        "price":{
            "description":"The alternate price for the barcode<br>If<br>minimum: 0<br>exclusiveMinimum: true<br>This means that the allowed values excludes the value of minimum, 0. So 0.000001 would be valid, but 0 would not.<br>If exclusiveMinimum: false then 0 and 0.000001 would be valid.<br>Zero price, preparationCost, definitionSequence or priceSequence are not allowed.",
            "type":"number",
            "format":"float",
            "minimum":0,
            "exclusiveMinimum":true
        },
        "priceSequence":{
            "description":"The price sequence for the barcode",
            "type":"integer",
            "format":"int32",
            "minimum":1
        },
        "preparationCost":{
            "description":"The alternate preparation cost for the barcode<br>If<br>minimum: 0<br>exclusiveMinimum: true<br>This means that the allowed values excludes the value of minimum, 0. So 0.000001 would be valid, but 0 would not.<br>If exclusiveMinimum: false then 0 and 0.000001 would be valid.<br>Zero price, preparationCost, definitionSequence or priceSequence are not allowed.",
            "type":"number",
            "format":"float",
            "minimum":0,
            "exclusiveMinimum":true
        }
    }
}

304 Response

304 Not Modified

Headers

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

400 Response

400 Bad Request

Root Schema : ConfigurationApiProblemDetails

Type: object

Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). The content type for this response is `application/problem+json`

Show Source

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

{
    "description":"Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807).\n\nThe content type for this response is `application/problem+json`\n",
    "type":"object",
    "properties":{
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"error:validation"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"Required value not specified."
        },
        "details":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"The OrgShortName value is required."
        },
        "instance":{
            "description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
            "type":"string",
            "example":"required_value_missing"
        }
    }
}

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
    }
  ]
}