listOrderTypes
get
/ccagent/v1/orderTypes
List Order Types. Lists all the order types.
Request
Supported Media Types
- application/json
Query Parameters
-
name(optional): string
An optional partial displayName of a order type to use for search.
-
orderTypeIds(optional): string
An optional, comma separated list of specific order type ID's to retrieve.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listOrderTypes_response
Type:
Show Source
object
-
items(optional):
object items
Additional Properties Allowed: additionalPropertiesthe list of order types keyed by order type name
Nested Schema : items
Type:
object
Additional Properties Allowed
Show Source
the list of order types keyed by order type name
Show Source
-
displayName(optional):
string
Display name of order type.
Example Response (application/json)
{
"order":{
"displayName":"Order"
}
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code