Jump to

• Request
• Response

Get Condiment Sets

post

/config/sim/v1/menuItems/getcondimentsets

Gets all the condiment sets

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : CondimentSetGetRequestBody

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: comboMealGroups.objectNum
• 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":"comboMealGroups.objectNum",
            "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 Condiment Sets

Body ()

Root Schema : CondimentSet

Type: object

Model for Condiment Set Object

Show Source

• condimentItems(optional): array condimentItems
  An array of menu items that are part of the condiment set
• hierUnitId: integer
  Unique reference of the hierarchy unit

  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
• 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
  Object Number of the condiment set

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "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"
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the condiment set"
        },
        "name":{
            "$ref":"#/definitions/TranslatedString"
        },
        "condimentItems":{
            "type":"array",
            "description":"An array of menu items that are part of the condiment set",
            "items":{
                "$ref":"#/definitions/CondimentSet_condimentItems"
            }
        }
    },
    "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_condimentItems

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

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 : CondimentSet_condimentItems

Type: object

Show Source

• condimentItemNum(optional): integer
  Sequence number of the condiment item

  Example: 1
• defaultCount(optional): integer
  The number of each condiment that comes with the set.

  Example: 1
• miDefSequence(optional): 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
• miMstrName(optional): object TranslatedString_MenuItemMasterName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the menu item master assigned to the condiment item in configured languages
• miMstrObjNum(optional): integer
  Object number of the menu item master assigned to the condiment item

  Example: 1
• options(optional): string
  A string value of 0???s & 1???s representing the enablement or disablement of the options associated with the condiment item

  Example: 000000
• optionsExt(optional): object CondimentSetItem_optionsExt
  An object containing the descriptive options list associated with the condiment item
• sortOrder(optional): 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"
        },
        "miMstrName":{
            "$ref":"#/definitions/TranslatedString_MenuItemMasterName"
        },
        "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":"000000",
            "description":"A string value of 0???s & 1???s 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 : TranslatedString_MenuItemMasterName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the menu item master assigned to the condiment item in configured languages",
    "example":{
        "en-US":"Condiment Set Items",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the menu item master assigned to the condiment item in configured languages

Example:

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

Nested Schema : CondimentSetItem_optionsExt

Type: object

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

Show Source

• persistOnPlain(optional): 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"
}

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