Configuration and Content API Guide

Get Order Channels

post

/config/sim/v1/setup/getorderchannels

Gets all the Order Channels

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 Channel objects.

Root Schema : OrderChannelGetResponse

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

Show Source

Array of: object OrderChannelResourceObject

Model for Order Channel Object

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

Nested Schema : OrderChannelResourceObject

Type: object

Model for Order Channel Object

Show Source

active: boolean

A Boolean flag indicating the order channel is active

Example: true
hierUnitId: integer

Unique hierarchy unit reference

Example: 2
hierUnitName: object hierUnitName

A string that contains translations of hierarchy unit name into multiple languages
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 1
name: object name

A string that contains translations into multiple languages
objectNum: integer

Object number of the Order Channel

Example: 2

{
    "description":"Model for Order Channel 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":"A string that contains translations of hierarchy unit name into multiple languages",
            "example":{
                "en-US":"Property",
                "de-DE":"Eigentum",
                "es-MX":"Propiedad"
            }
        },
        "objectNum":{
            "type":"integer",
            "example":2,
            "description":"Object number of the Order Channel"
        },
        "name":{
            "type":"object",
            "description":"A string that contains translations into multiple languages\n",
            "example":{
                "en-US":"Order Channel",
                "de-DE":"Bestellkanal",
                "es-MX":"Canal de pedidos"
            }
        },
        "active":{
            "type":"boolean",
            "example":true,
            "description":"A Boolean flag indicating the order channel is active"
        }
    }
}

Nested Schema : hierUnitName

Type: object

A string that contains translations of hierarchy unit name into multiple languages

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "es-MX":"Propiedad"
}

Nested Schema : name

Type: object

A string that contains translations into multiple languages

Example:

{
    "en-US":"Order Channel",
    "de-DE":"Bestellkanal",
    "es-MX":"Canal de pedidos"
}