Configuration and Content API Guide

Get Condiment Sets

post

/config/sim/v2/menuItems/getCondimentSets

Gets all the condiment sets

Request

Supported Media Types

application/json
multipart/form-data

The input Body model that needs to be given.

Root Schema : schema

Type: object

Show Source

include: string

If specified, limits the data returned to these fields.

Example: hierUnitId, objectNum, name
includeAll: string

If this value is specified, the include parameter is ignored.

Value Description

basic Forces the response to include all fields except option string details

detailed Forces the response to include all fields including option string details

Example: detailed
langIds: string

If specified, limits translated strings returned

Example: 1,2,3
limit: integer

If using paging, number of results returned in this page.

Example: 100
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order.

Example: hierUnitId:asc
searchCriteria: string

If specified, returns records that match the criteria.

Example: where equals(hierUnitId, 7)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierUnitId, 7)",
            "description":"If specified, returns records that match the criteria."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"hierUnitId:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of Condiment Sets

Root Schema : schema

Type: object

Show Source

count: integer

Current response record count.

Example: 9
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Array of Condiment Set objects of the organization.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: 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 record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Condiment Set objects of the organization.",
            "items":{
                "$ref":"#/definitions/CondimentSetsv2"
            }
        },
        "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 Condiment Set objects of the organization.

Show Source

Array of: object CondimentSetsv2

Model for Condiment Set Object

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

Nested Schema : CondimentSetsv2

Type: object

Model for Condiment Set Object

Show Source

condimentItems: array condimentItems

An array of menu items that are part of the condiment set
hierUnitId: integer

Unique reference of the hierarchy unit

Example: 2
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 1
name: object name

Condiment Set Name
objectNum: integer

Object Number of the condiment set

Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the condiment set"
        },
        "name":{
            "type":"object",
            "description":"Condiment Set Name",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "condimentItems":{
            "type":"array",
            "description":"An array of menu items that are part of the condiment set",
            "items":{
                "$ref":"#/definitions/CondimentSet_condimentItemsv2"
            }
        }
    },
    "description":"Model for Condiment Set Object"
}

Nested Schema : condimentItems

Type: array

An array of menu items that are part of the condiment set

Show Source

Array of: object CondimentSet_condimentItemsv2

{
    "type":"array",
    "description":"An array of menu items that are part of the condiment set",
    "items":{
        "$ref":"#/definitions/CondimentSet_condimentItemsv2"
    }
}

Nested Schema : name

Type: object

Condiment Set Name

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

Nested Schema : CondimentSet_condimentItemsv2

Type: object

Show Source

condimentItemNum: integer

Sequence number of the condiment item

Example: 1
defaultCount: integer

The number of each condiment that comes with the set.

Example: 1
miDefSequence: integer

The Menu Item definition sequence number of each record. This coincides with the Menu Item Definition that appears in the POS client when the condiment is triggered.

Example: 0
miMstrObjNum: integer

Object number of the menu item master assigned to the condiment item

Example: 1
options: string

A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment item

Example: 00000000
optionsExt: object CondimentSetItem_optionsExt

An object containing the descriptive options list associated with the condiment item
sortOrder: integer

The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. 0 - Ascending 1 - Descending

Example: 1

{
    "type":"object",
    "properties":{
        "condimentItemNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the condiment item"
        },
        "miMstrObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the menu item master assigned to the condiment item"
        },
        "defaultCount":{
            "type":"integer",
            "example":1,
            "description":"The number of each condiment that comes with the set."
        },
        "sortOrder":{
            "type":"integer",
            "example":1,
            "description":"The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. 0 - Ascending 1 - Descending"
        },
        "options":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment item"
        },
        "optionsExt":{
            "$ref":"#/definitions/CondimentSetItem_optionsExt"
        },
        "miDefSequence":{
            "type":"integer",
            "example":0,
            "description":"The Menu Item definition sequence number of each record. This coincides with the Menu Item Definition that appears in the POS client when the condiment is triggered."
        }
    }
}

Nested Schema : CondimentSetItem_optionsExt

Type: object

An object containing the descriptive options list associated with the condiment item

Show Source

persistOnPlain: boolean

A Boolean flag indicating to keep the selected condiment when the menu item is changed to Plain. Deselect to remove it.

Example: true

{
    "type":"object",
    "properties":{
        "persistOnPlain":{
            "type":"boolean",
            "example":true,
            "description":"A Boolean flag indicating to keep the selected condiment when the menu item is changed to Plain. Deselect to remove it."
        }
    },
    "description":"An object containing the descriptive options list associated with the condiment item"
}

Value	Description
basic	Forces the response to include all fields except option string details
detailed	Forces the response to include all fields including option string details