Jump to

• Request
• Response

Get Order Types Parameters

post

/config/sim/v1/setup/getOrderTypeParameters

Gets all the Order Type Parameters

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Get Request Body

Root Schema : OrderTypeParameterGetRequestBody

Type: object

Show Source

• include(optional): string
  Example: locations
• languages(optional): string
  If specified, limits translated strings returned.

  Example: en-US, es-SS,lt-LT
• limit(optional): integer
  Number of results returned in this page. Not required if paging parameters are not supported.

  Example: 10
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported

  Example: 2
• orderBy(optional): string
  Sorts the response by the specified field name and sort order.

  Example: items.objectNum:asc
• searchCriteria(optional): string
  Search criteria to filter results based on field value

  Example: where equals(active,1)

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "example":2,
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Number of results returned in this page. Not required if paging parameters are not supported."
        },
        "orderBy":{
            "type":"string",
            "example":"items.objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"locations"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-SS,lt-LT",
            "description":"If specified, limits translated strings returned."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Order Type Parameter objects of the organization

Body ()

Root Schema : OrderTypeParametersGetResponse

Type: object

Show Source

• count(optional): integer
  Current response recount count.

  Example: 9
• hasMore(optional): boolean
  Flag indicating if there are more objects to fetch.

  Example: true
• items(optional): array items
  Array of language objects of the organization.
• limit(optional): integer
  Server page size

  Example: 10
• offset(optional): integer
  Starting resource record index

  Example: 0
• totalResults(optional): integer
  Total number of rows (excluding the paging parameters)

  Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response recount count."
        },
        "items":{
            "type":"array",
            "description":"Array of language objects of the organization.",
            "items":{
                "$ref":"#/definitions/OrderTypeParametersResourceObject"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of language objects of the organization.

Show Source

• Array of: object OrderTypeParametersResourceObject

{
    "type":"array",
    "description":"Array of language objects of the organization.",
    "items":{
        "$ref":"#/definitions/OrderTypeParametersResourceObject"
    }
}

Nested Schema : OrderTypeParametersResourceObject

Type: object

Show Source

• active(optional): boolean
  A Boolean flag indicating the order type is active

  Example: false
• hierUnitId: integer
  Unique hierarchy unit reference

  Example: 2
• hierUnitName(optional): object TranslatedString_HierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum(optional): integer
  Object number of the hierarchy unit

  Example: 1
• kdsHighlightSchemeName(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• kdsHighlightSchemeObjNum(optional): integer
  Object number of the KDS Highlight Scheme to use for the order type parameter

  Example: 0
• name: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• objectNum: integer
  Unique reference of the Order Type

  Example: 1
• options(optional): string
  A string value of 0???s & 1???s representing enabled or disabled options

  Example: 0000000000000000000000
• optionsExt(optional): object OrderTypeParameters_OptionsExt
• orderDeviceMask(optional): string
  A string value of 0???s & 1???s representing the enablement or disablement of the order device mask associated with the Order Type parameter

  Example: 00000000
• orderDeviceMaskExt(optional): object OrderTypeParameters_orderDeviceMaskExt
• slaTime(optional): integer
  Service Level Agreement Time

  Example: 0
• taxMask(optional): string
  A string value of 0???s & 1???s representing the enablement or disablement of the tax mask associated with the Order Type parameter

  Example: 0000000000000000000000
• taxMaskExt(optional): object OrderTypeParameters_taxMaskExt

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the Order Type"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString"
        },
        "options":{
            "type":"string",
            "example":"0000000000000000000000",
            "description":"A string value of 0???s & 1???s representing enabled or disabled options"
        },
        "optionsExt":{
            "$ref":"#/definitions/OrderTypeParameters_OptionsExt"
        },
        "taxMask":{
            "type":"string",
            "example":"0000000000000000000000",
            "description":"A string value of 0???s & 1???s representing the enablement or disablement of the tax mask associated with the Order Type parameter"
        },
        "taxMaskExt":{
            "$ref":"#/definitions/OrderTypeParameters_taxMaskExt"
        },
        "active":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating the order type is active"
        },
        "orderDeviceMask":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0???s & 1???s representing the enablement or disablement of the order device mask associated with the Order Type parameter"
        },
        "orderDeviceMaskExt":{
            "$ref":"#/definitions/OrderTypeParameters_orderDeviceMaskExt"
        },
        "kdsHighlightSchemeObjNum":{
            "type":"integer",
            "example":0,
            "description":"Object number of the KDS Highlight Scheme to use for the order type parameter"
        },
        "kdsHighlightSchemeName":{
            "$ref":"#/definitions/TranslatedString"
        },
        "slaTime":{
            "type":"integer",
            "example":0,
            "description":"Service Level Agreement Time"
        }
    }
}

Nested Schema : TranslatedString_HierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "example":{
        "en-US":"Enterprise",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A string that contains translations into multiple languages\n\n**Example**\n`{ \"en-US\": \"coffee\", \"de-DE\": \"kaffee\", \"ar-AR\": \"????????\" }`\n",
    "type":"object",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "ar-AR":"????????"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "ar-AR":"????????"
}

Nested Schema : OrderTypeParameters_OptionsExt

Type: object

Show Source

• alwaysUseKDSPrepTime(optional): boolean
  A Boolean flag indicating to suppress Menu Item Class | Options | 83 and 84.

  Example: false
• dontPostTransToTipReportTotals(optional): boolean
  A Boolean flag indicating to prevent posting sales for this Order Type to the Gross Receipts and Charged Receipts totals on Tip Reports.

  Example: false
• enableGuesTCountByMenuItemInTransService(optional): boolean
  A Boolean flag indicating to enable transaction services to count guests like POS operations.

  Example: false
• enableRoutingOrderByOrderType(optional): boolean
  A Boolean flag indicating to control order routing by Order Type.

  Example: false
• forgiveInclTax(optional): boolean
  A Boolean flag indicating to forgive the Inclusive Tax for eligible Menu Items, Australian GST only.

  Example: false
• kdsAllowItemPrintOnAllPrepDone(optional): boolean
  A Boolean flag indicating to allow printing a runner chit for each item in the all prep done state.

  Example: false
• performAutoComboRecognition(optional): boolean
  A Boolean flag indicating to automatically perform Auto-Combo Recognition when a workstation operator changes the workstation to this Order Type.

  Example: false
• printOnCustomerReceiptAndCheck(optional): boolean
  A Boolean flag indicating to print the Order Type name on customer receipts and guest checks.

  Example: false
• printOnOrderPrinter(optional): boolean
  A Boolean flag indicating to print the Order Type name on order printers.

  Example: false
• supressDiningCourse(optional): boolean
  A Boolean flag indicating to ignore Dining Courses for orders using this Order Type.

  Example: false
• transCancelDefault(optional): boolean
  A Boolean flag indicating to apply this Order Type to transactions that are canceled before declaring an Order Type.

  Example: false

{
    "type":"object",
    "properties":{
        "printOnCustomerReceiptAndCheck":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to print the Order Type name on customer receipts and guest checks."
        },
        "printOnOrderPrinter":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to print the Order Type name on order printers."
        },
        "enableGuesTCountByMenuItemInTransService":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to enable transaction services to count guests like POS operations."
        },
        "dontPostTransToTipReportTotals":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to prevent posting sales for this Order Type to the Gross Receipts and Charged Receipts totals on Tip Reports."
        },
        "performAutoComboRecognition":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to automatically perform Auto-Combo Recognition when a workstation operator changes the workstation to this Order Type."
        },
        "transCancelDefault":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to apply this Order Type to transactions that are canceled before declaring an Order Type."
        },
        "enableRoutingOrderByOrderType":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to control order routing by Order Type."
        },
        "kdsAllowItemPrintOnAllPrepDone":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to allow printing a runner chit for each item in the all prep done state."
        },
        "supressDiningCourse":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to ignore Dining Courses for orders using this Order Type."
        },
        "forgiveInclTax":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to forgive the Inclusive Tax for eligible Menu Items, Australian GST only."
        },
        "alwaysUseKDSPrepTime":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to suppress Menu Item Class | Options | 83 and 84."
        }
    }
}

Nested Schema : OrderTypeParameters_orderDeviceMaskExt

Type: object

Show Source

• mask(optional): boolean
  A Boolean flag indicating to mask the order device for the order type.

  Example: false
• orderDeviceNum(optional): integer
  Object number of the order device that is to be masked with the Order Type.

  Example: 1

{
    "type":"object",
    "properties":{
        "orderDeviceNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the order device that is to be masked with the Order Type."
        },
        "mask":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to mask the order device for the order type."
        }
    }
}

Nested Schema : OrderTypeParameters_taxMaskExt

Type: object

Show Source

• mask(optional): boolean
  A Boolean flag indicating to mask the tax for the order type.

  Example: false
• taxObjNum(optional): integer
  Object number of the tax that is to be masked with the Order Type.

  Example: 1

{
    "type":"object",
    "properties":{
        "taxObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the tax that is to be masked with the Order Type."
        },
        "mask":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to mask the tax for the order type."
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "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":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top