Configuration and Content API Guide

Get Order Types

post

/config/sim/v1/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

Objects included in the response.

Example: hierUnitId
includeAll: string

This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

Example: detailed
languages: string

If specified, limits the translated strings returned.

Example: en-US, es-ES, es-MX
limit: integer

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

Example: 10
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: objectNum:asc
searchCriteria: string

Search criteria to filter results based on field value.

Example: where equals(objectNum,1)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum,1)",
            "description":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId",
            "description":"Objects included in the response."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-ES, es-MX",
            "description":"If specified, limits the translated strings returned."
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index. Not required if paging parameters are not supported."
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of Order Type Names.

Root Schema : OrderTypeGetResponse

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

Show Source

Array of: object OrderTypeResourceObject

Model for Order Type Object

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

Nested Schema : OrderTypeResourceObject

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
hierUnitName: object hierUnitName

Hier Unit Name
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 1
lineNum: integer

Line number of the Order Types

Example: 1
name: object name

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"
        },
        "hierUnitName":{
            "type":"object",
            "description":"Hier Unit Name",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            }
        },
        "lineNum":{
            "type":"integer",
            "example":1,
            "description":"Line number of the Order Types"
        },
        "name":{
            "type":"object",
            "description":"Name",
            "example":{
                "en-US":"Coffee",
                "de-DE":"Kaffee",
                "es-MX":"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 : hierUnitName

Type: object

Hier Unit Name

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

Nested Schema : name

Type: object

Name

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "es-MX":"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"
        }
    }
}