Get Order Channels
post
/config/sim/v2/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:
Show Source
object-
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 returnedExample:
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 supportedExample:
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)
Response
Supported Media Types
- application/json
200 Response
A collection of Order Channel objects.
Root Schema : schema
Type:
Show Source
object-
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 sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Order Channel objects of the organization.
Show Source
-
Array of:
object OrderChannelv2
Model for Order Channel Object
Nested Schema : OrderChannelv2
Type:
objectModel for Order Channel Object
Show Source
-
active:
boolean
A Boolean flag indicating the order channel is activeExample:
true -
hierUnitId:
integer
Unique hierarchy unit referenceExample:
2 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
name:
object name
A string that contains translations into multiple languages
-
objectNum:
integer
Object number of the Order ChannelExample:
2
Nested Schema : name
Type:
objectA string that contains translations into multiple languages
Example:
{
"1":"Order Channel",
"2":"Bestellkanal",
"3":"Canal de pedidos"
}