getOrderType
get
/ccagent/v1/orderTypes/{id}
Get Order Type. Get information about order types by ID.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID of order type.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getOrderType_response
Type:
Show Source
object-
displayName(optional):
string
Display name of item type.
-
id(optional):
string
ID of order type.
-
properties(optional):
object properties
Additional Properties Allowed: additionalPropertiesList of user-defined properties for order type keyed by property name.
-
propertiesOrder(optional):
array propertiesOrder
List of properties in ascending order
Nested Schema : properties
Type:
objectAdditional Properties Allowed
Show Source
List of user-defined properties for order type keyed by property name.
Show Source
-
default(optional):
string
Default property value of order type.
-
dimension(optional):
string
Dimension of property.
-
editableAttributes(optional):
array editableAttributes
List of editable attributes
-
internalOnly(optional):
boolean
Whether property is internal.
-
label(optional):
string
Label for new item type.
-
length(optional):
integer
length of type supported.
-
multiSelect(optional):
boolean
whether multi-select search facet or not
-
required(optional):
boolean
Whether it is required or not.
-
searchable(optional):
boolean
Whether searchable or not.
-
textSearchable(optional):
boolean
Whether text is searchable or not.
-
type(optional):
string
Data type of property.
-
uiEditorType(optional):
object uiEditorType
The UI editor type
Nested Schema : uiEditorType
Type:
objectThe UI editor type
Nested Schema : items
Type:
Show Source
object-
default(optional):
string
Default editable attribute.
-
dimension(optional):
string
Dimensions of item type.
-
internalOnly(optional):
boolean
Whether properties are internal.
-
label(optional):
string
Label for the item type.
-
multiSelect(optional):
boolean
whether multi-select search facet or not.
-
required(optional):
boolean
Whether it is required or not.
-
searchable(optional):
boolean
Whether item searchable or not.
-
textSearchable(optional):
boolean
Whether property is searchable or not.
Example Response (application/json)
{
"propertiesOrder":[
"login",
"password",
"email",
"autoLogin",
"generatedPassword",
"lastEmailed",
"emailStatus",
"receiveEmail",
"lastPasswordGenerate",
"lastActivity",
"lastPasswordUpdate",
"registrationDate",
"derivedApprovalRequired",
"firstName",
"middleName",
"derivedOrderPriceLimit",
"lastName",
"gender",
"daytimeTelephoneNumber",
"member",
"orderType",
"locale",
"securityStatus",
"description",
"realmId",
"defaultCarrier",
"abandonedOrderCount",
"allowPartialShipment",
"currentLocation",
"accessTokenSigningKey",
"expressCheckout"
],
"displayName":"Order",
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/orderTypes/order?properties=%5Bobject%20Object%5D"
}
],
"id":"order",
"properties":{
"orderType":{
"internalOnly":null,
"default":null,
"length":10,
"textSearchable":false,
"localizable":false,
"label":"Order type",
"type":"number",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"lastName":{
"internalOnly":null,
"default":null,
"length":254,
"textSearchable":false,
"localizable":false,
"label":"Last name",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"accessTokenSigningKey":{
"internalOnly":null,
"default":null,
"length":254,
"textSearchable":false,
"localizable":false,
"label":"accessTokenSigningKey",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"gender":{
"internalOnly":null,
"default":"female",
"length":32,
"textSearchable":false,
"localizable":false,
"label":"Gender",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"generatedPassword":{
"internalOnly":null,
"default":false,
"length":1,
"textSearchable":false,
"localizable":false,
"label":"Generated password",
"type":"checkbox",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"allowPartialShipment":{
"internalOnly":null,
"default":false,
"length":1,
"textSearchable":false,
"localizable":false,
"label":"Allow partial shipment",
"type":"checkbox",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"defaultCarrier":{
"internalOnly":null,
"default":null,
"length":254,
"textSearchable":false,
"localizable":false,
"label":"Default carrier",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"description":{
"internalOnly":null,
"default":null,
"length":254,
"textSearchable":false,
"localizable":false,
"label":"Description",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"locale":{
"internalOnly":null,
"default":null,
"length":32,
"textSearchable":false,
"localizable":false,
"label":"Locale",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"login":{
"internalOnly":null,
"default":null,
"length":254,
"textSearchable":false,
"localizable":false,
"label":"Login name",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"searchable"
],
"required":true,
"searchable":false,
"multiSelect":null
},
"securityStatus":{
"internalOnly":null,
"default":0,
"length":10,
"textSearchable":false,
"localizable":false,
"label":"Security status",
"type":"number",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"autoLogin":{
"internalOnly":null,
"default":false,
"length":1,
"textSearchable":false,
"localizable":false,
"label":"Auto login",
"type":"checkbox",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"password":{
"internalOnly":null,
"default":null,
"length":254,
"textSearchable":false,
"localizable":false,
"label":"Password",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"searchable"
],
"required":true,
"searchable":false,
"multiSelect":null
},
"registrationDate":{
"internalOnly":null,
"default":"2015-08-04T03:42:42.876Z",
"length":26,
"textSearchable":false,
"localizable":false,
"label":"Registration date",
"type":"date",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"member":{
"internalOnly":null,
"default":false,
"length":1,
"textSearchable":false,
"localizable":false,
"label":"Member",
"type":"checkbox",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"lastPasswordGenerate":{
"internalOnly":null,
"default":null,
"length":26,
"textSearchable":false,
"localizable":false,
"label":"lastPasswordGenerate",
"type":"date",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"email":{
"internalOnly":null,
"default":null,
"length":254,
"textSearchable":false,
"localizable":false,
"label":"Email address",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"daytimeTelephoneNumber":{
"internalOnly":null,
"default":null,
"length":254,
"textSearchable":false,
"localizable":false,
"label":"Daytime telephone number",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"realmId":{
"internalOnly":null,
"default":null,
"length":254,
"textSearchable":false,
"localizable":false,
"label":"Profile Realm",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"derivedOrderPriceLimit":{
"internalOnly":null,
"default":null,
"length":22,
"textSearchable":false,
"localizable":false,
"label":"Order limit",
"type":"number",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"receiveEmail":{
"internalOnly":null,
"default":"yes",
"length":32,
"textSearchable":false,
"localizable":false,
"label":"Receive email",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"lastEmailed":{
"internalOnly":null,
"default":null,
"length":26,
"textSearchable":false,
"localizable":false,
"label":"lastEmailed",
"type":"date",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"currentLocation":{
"internalOnly":null,
"default":"unknown",
"length":0,
"textSearchable":false,
"localizable":false,
"label":"Current location",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"abandonedOrderCount":{
"internalOnly":null,
"default":null,
"length":10,
"textSearchable":false,
"localizable":false,
"label":"Number of abandoned orders",
"type":"number",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"firstName":{
"internalOnly":null,
"default":null,
"length":254,
"textSearchable":false,
"localizable":false,
"label":"First name",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"emailStatus":{
"internalOnly":null,
"default":"unknown",
"length":32,
"textSearchable":false,
"localizable":false,
"label":"Email status",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"derivedApprovalRequired":{
"internalOnly":null,
"default":false,
"length":1,
"textSearchable":false,
"localizable":false,
"label":"Approval required",
"type":"checkbox",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"expressCheckout":{
"internalOnly":null,
"default":false,
"length":1,
"textSearchable":false,
"localizable":false,
"label":"Express checkout",
"type":"checkbox",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"lastPasswordUpdate":{
"internalOnly":null,
"default":"2015-08-04T03:42:42.962Z",
"length":26,
"textSearchable":false,
"localizable":false,
"label":"Last password update",
"type":"date",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"lastActivity":{
"internalOnly":null,
"default":null,
"length":26,
"textSearchable":false,
"localizable":false,
"label":"Last activity",
"type":"date",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
},
"middleName":{
"internalOnly":null,
"default":null,
"length":254,
"textSearchable":false,
"localizable":false,
"label":"Middle name",
"type":"shortText",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"required":false,
"searchable":false,
"multiSelect":null
}
}
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|75001|Not supported type|
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:
arrayAn 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