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 Order Channel Parameter 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 Order Channel Parameter objects of the organization.",
            "items":{
                "$ref":"#/definitions/OrderChannelParametersResourceObjectv2"
            }
        },
        "offset":{
            "type":"integer",
            "example":"0",
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":"10",
            "description":"Server page size"
        }
    }
}

Show Source

• Array of: object OrderChannelParametersResourceObjectv2

{
    "type":"array",
    "description":"Array of Order Channel Parameter objects of the organization.",
    "items":{
        "$ref":"#/definitions/OrderChannelParametersResourceObjectv2"
    }
}

Show Source

• active: boolean
  A Boolean flag indicating the order channel is active

  Example: false
• hierUnitId: integer
  Unique hierarchy unit reference

  Example: 2
• hierUnitObjNum: integer
  Object number of the hierarchy unit

  Example: 1
• objectNum: 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: 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",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":"2",
            "description":"Unique hierarchy unit reference"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":"1",
            "description":"Object number of the hierarchy unit"
        },
        "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"
        }
    }
}

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."
        }
    }
}

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."
        }
    }
}

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