Get Order Channels
post
/config/sim/v1/setup/getorderchannels
Gets all the Order Channels
Request
Supported Media Types
- application/json
- multipart/form-data
Get Request Body
Root Schema : OrderChannelGetRequestBody
Type:
Show Source
object-
include:
string
Objects included in responseExample:
locations -
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 translated strings returned.Example:
en-US, de-DE, es-MX -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Order Channel objects of the organization
Root Schema : OrderChannelGetResponse
Type:
Show Source
object-
count(required):
integer
Current response recount count.Example:
9 -
hasMore(required):
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items(required):
array items
Array of Order Channel objects of the organization.
-
limit(required):
integer
Server page sizeExample:
10 -
offset(required):
integer
Starting resource record indexExample:
0 -
totalResults(required):
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 OrderChannelResourceObject
Model for Order Channel Object
Nested Schema : OrderChannelResourceObject
Type:
objectModel for Order Channel Object
Show Source
-
active(required):
boolean
A Boolean flag indicating the order channel is activeExample:
true -
hierUnitId(required):
integer
Unique hierarchy unit referenceExample:
2 -
hierUnitName(required):
object hierUnitName
A string that contains translations of hierarchy unit name into multiple languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 -
name(required):
object name
A string that contains translations into multiple languages
-
objectNum(required):
integer
Object number of the Order ChannelExample:
2
Nested Schema : hierUnitName
Type:
objectA 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:
objectA string that contains translations into multiple languages
Example:
{
"en-US":"Order Channel",
"de-DE":"Bestellkanal",
"es-MX":"Canal de pedidos"
}400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
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 problemExample:
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
404 Response
404 Requested resource not found