Configuration and Content API Guide

Get Order Types

post

/config/sim/v2/setup/getOrderTypeNames

Gets all the Order Types

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 Order Type Names.

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 Order Type 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 Type objects of the organization.",
            "items":{
                "$ref":"#/definitions/OrderTypev2"
            }
        },
        "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 Order Type objects of the organization.

Show Source

Array of: object OrderTypev2

Model for Order Type Object

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

Nested Schema : OrderTypev2

Type: object

Model for Order Type Object

Show Source

dataExtensions: array dataExtensions

An array of data extensions for the Order Types
hierUnitId: integer

Unique hierarchy unit reference

Example: 2
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 1
lineNum: integer

Line number of the Order Types

Example: 1
name: object name

Order Type Name

{
    "description":"Model for Order Type Object",
    "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"
        },
        "lineNum":{
            "type":"integer",
            "example":1,
            "description":"Line number of the Order Types"
        },
        "name":{
            "type":"object",
            "description":"Order Type Name",
            "example":{
                "1":"Coffee",
                "2":"Kaffee",
                "3":"Cafe"
            }
        },
        "dataExtensions":{
            "description":"An array of data extensions for the Order Types",
            "type":"array",
            "items":{
                "$ref":"#/definitions/OrderType_dataExtentions"
            }
        }
    }
}

Nested Schema : dataExtensions

Type: array

An array of data extensions for the Order Types

Show Source

Array of: object OrderType_dataExtentions

{
    "description":"An array of data extensions for the Order Types",
    "type":"array",
    "items":{
        "$ref":"#/definitions/OrderType_dataExtentions"
    }
}

Nested Schema : name

Type: object

Order Type Name

Example:

{
    "1":"Coffee",
    "2":"Kaffee",
    "3":"Cafe"
}

Nested Schema : OrderType_dataExtentions

Type: object

Show Source

columnName: string

Name of the extention field

Example: Extention Column 1
value: string

Value of the extention field

Example: Value 1

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "example":"Value 1",
            "description":"Value of the extention field"
        },
        "columnName":{
            "type":"string",
            "example":"Extention Column 1",
            "description":"Name of the extention field"
        }
    }
}

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