Configuration and Content API Guide

Add Order Channel Parameters

post

/config/sim/v1/setup/orderchannelparameters

Add the Order Channel Parameter object to a specified hierarchy unit.

Request

Supported Media Types

application/json
multipart/form-data

Header Parameters

Simphony-AuditTrailRef: string(string)

Detail that Identifies that who made the change

Order Channel Parameters Request Body for Create and Update requests.

Root Schema : OrderChannelParametersCURequestBody

Type: object

Show Source

active: boolean

A Boolean flag indicating the order channel is active

Example: false
hierUnitId(required): integer

Unique hierarchy unit reference

Example: 2
objectNum(required): integer

Unique reference of the Order Channel Parameter

Example: 2
options: string

A string value of 0s & 1s of length 32 representing enabled or disabled options

Example: 00000000000000000000000000000000
optionsExt: object OrderChannelParameters_OptionsExt
orderChannelId(required): integer

Unique reference of the Order Channel

Example: 1
orderDeviceMask: string

A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Channel parameter

Example: 00000000000000000000000000000000
orderDeviceMaskExt: object OrderChannelParameters_orderDeviceMaskExt

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "orderChannelId"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":"2",
            "description":"Unique hierarchy unit reference"
        },
        "objectNum":{
            "type":"integer",
            "example":"2",
            "description":"Unique reference of the Order Channel Parameter"
        },
        "orderChannelId":{
            "type":"integer",
            "example":"1",
            "description":"Unique reference of the Order Channel"
        },
        "options":{
            "type":"string",
            "example":"00000000000000000000000000000000",
            "description":"A string value of 0s & 1s of length 32 representing enabled or disabled options"
        },
        "optionsExt":{
            "$ref":"#/definitions/OrderChannelParameters_OptionsExt"
        },
        "active":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating the order channel is active"
        },
        "orderDeviceMask":{
            "type":"string",
            "example":"00000000000000000000000000000000",
            "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Channel parameter"
        },
        "orderDeviceMaskExt":{
            "$ref":"#/definitions/OrderChannelParameters_orderDeviceMaskExt"
        }
    }
}

Nested Schema : OrderChannelParameters_OptionsExt

Type: object

Show Source

enableRoutingOrderByOrderChannel: boolean

A Boolean flag indicating to control order routing by Order Channel.

Example: false
printOnCustomerReceiptAndCheck: boolean

A Boolean flag indicating to print the Order Channel name on customer receipts and guest checks.

Example: false
printOnOrderPrinter: boolean

A Boolean flag indicating to print the Order Channel name on order printers.

Example: false

{
    "type":"object",
    "properties":{
        "printOnCustomerReceiptAndCheck":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to print the Order Channel name on customer receipts and guest checks."
        },
        "printOnOrderPrinter":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to print the Order Channel name on order printers."
        },
        "enableRoutingOrderByOrderChannel":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to control order routing by Order Channel."
        }
    }
}

Nested Schema : OrderChannelParameters_orderDeviceMaskExt

Type: object

Show Source

mask: boolean

A Boolean flag indicating to mask the order device for the order channel.

Example: false
orderDeviceNum: integer

Object number of the order device that is to be masked with the Order Channel.

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 Channel."
        },
        "mask":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating to mask the order device for the order channel."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Order channel parameters response body for Create and Update Requests

Root Schema : OrderChannelParameterCUResponse

Type: object

Show Source

hierUnitId(required): integer

Unique hierarchy unit value

Example: 1
objectNum(required): integer

Unique reference of the Order Channel Parameter

Example: 2

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":"1",
            "description":"Unique hierarchy unit value"
        },
        "objectNum":{
            "type":"integer",
            "example":"2",
            "description":"Unique reference of the Order Channel Parameter"
        }
    }
}

400 Response

400 Bad Request

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

detail(required): string

A short, human-readable summary of the problem.

Example: Specified Data is invalid
errorDetails(required): string

A human-readable explanation specific to this occurrence of the problem.

Example: Entity Does Not Exist
o:errorCode(required): integer

Error code of the problem

Example: 55223
status(required): integer

HTTP status code.

Example: 400
title(required): string

A short, human-readable summary of the problem type.

Example: VALIDATION ERROR
type(required): 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",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "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"
        }
    }
}