getItemType
get
/ccadmin/v1/itemTypes/{id}
Get Item Type. Get information about item types by ID. Optionally takes the x-ccasset-language header to get translated content in another language. Supported item types:
- commerceItem
- organization
- promotion
- gift-list
- gift-item
- organizationRequest
- profileRequest
- userSiteProperties
- profileAgentComment
- orderAgentComment
- loyaltyPrograms
- mailing
- contactInfo
- creditCard
- tokenizedCreditCard
- hardgoodShippingGroup
- electronicShippingGroup
- inStorePickupShippingGroup
- invoiceRequest
- onlinePaymentGroup
- physicalGiftCard
- customCurrencyPaymentGroup
- quoteInfo
- returnComment
- returnItem
- inStoreTakeWithShippingGroup
- category
- appeasement
- appeasementComment
- appeasementRefund
- externalAppeasementRefund
- creditCardAppeasementRefund
- storeCreditAppeasementRefund
- tokenizedCreditCardAppeasementRefund
- onlinePaymentGroupAppeasementRefund
- physicalGiftCardAppeasementRefund
- customCurrencyAppeasementRefund
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID of item type.
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getItemType_response
Type:
Show Source
object
-
displayName(optional):
string
Display name of item type.
-
id(optional):
string
ID of item type.
-
propertiesOrder(optional):
array propertiesOrder
List of properties in ascending order
-
specifications(optional):
array specifications
List of specifications for user-defined item type.
Nested Schema : specifications
Type:
array
List of specifications for user-defined item type.
Show Source
Nested Schema : items
Type:
Show Source
object
-
custom(optional):
boolean
Whether it is a custom property.
-
default(optional):
string
Default value of specificaion.
-
dimension(optional):
string
Dimension of specification.
-
editableAttributes(optional):
array editableAttributes
List of editable properties
-
id(optional):
string
ID of specification.
-
internalOnly(optional):
boolean
Whether specification is internal.
-
label(optional):
string
Label for new item type.
-
length(optional):
boolean
Length of type supported.
-
localizable(optional):
boolean
Whether specification is localizable or not.
-
multiSelect(optional):
number
Whether multi-select search facet or not.
-
readAccessRight(optional):
string
Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)
-
readRole(optional):
string
Can be set to a single role id, in which case a user must have that role in order to read the property.
-
readSecurityLevel(optional):
string
Can be set to "deny" or "ignore", with "ignore" being the default behavior. Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute. Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error. Deny security is only available on custom properties.
-
required(optional):
number
Whether specification is required or not.
-
searchable(optional):
boolean
Whether item searchable or not.
-
securityMaskingValue(optional):
string
A value to return if the read fails the security check and the readSecurityLevel is ignore.
-
shopperReadable(optional):
string
If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.
-
shopperWritable(optional):
string
If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile.
-
textSearchable(optional):
boolean
Whether text is searchable or not.
-
type(optional):
string
Data type of specification.
-
uiEditorType(optional):
string
The UI editor type.
-
validationPattern(optional):
string
Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.
-
writable(optional):
string
Whether writable or not.
-
writeAccessRight(optional):
string
Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)
-
writeRole(optional):
string
Can be set to a single role id, in which case a user must have that role in order to write the property.
-
writeSecurityLevel(optional):
string
Can be set to "deny" or "ignore", with "ignore" being the default behavior. Ignore means that writes will fail silently. Deny means that attempts to write the property will result in an error.
Example Response (application/json)
{
"propertiesOrder":[
"derivedApprovalRequired",
"name",
"description",
"derivedOrderPriceLimit",
"customerType",
"derivedCustomerType",
"type",
"dunsNumber",
"organizationLogo",
"uniqueId",
"taxReferenceNumber",
"vatReferenceNumber",
"active",
"TestShortItemType2"
],
"displayName":"Organization",
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/itemTypes/organization"
}
],
"id":"organization",
"specifications":[
{
"validationPattern":null,
"custom":false,
"length":22,
"label":"Order limit",
"type":"number",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"number",
"internalOnly":false,
"default":null,
"localizable":false,
"textSearchable":false,
"id":"derivedOrderPriceLimit",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"multiSelect":null
},
{
"validationPattern":null,
"custom":false,
"length":0,
"label":"Customer type",
"type":"shortText",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"shortText",
"internalOnly":false,
"default":null,
"localizable":false,
"textSearchable":false,
"id":"customerType",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"multiSelect":null
},
{
"validationPattern":null,
"custom":true,
"length":254,
"label":"TestShortItemType2",
"type":"shortText",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"shortText",
"internalOnly":false,
"default":null,
"localizable":false,
"textSearchable":false,
"id":"TestShortItemType2",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"multiSelect":false
},
{
"validationPattern":null,
"custom":false,
"length":254,
"label":"vatReferenceNumber",
"type":"shortText",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"shortText",
"internalOnly":false,
"default":null,
"localizable":false,
"textSearchable":false,
"id":"vatReferenceNumber",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"multiSelect":null
},
{
"validationPattern":null,
"custom":false,
"length":0,
"label":"Type",
"type":"shortText",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"shortText",
"internalOnly":false,
"default":null,
"localizable":false,
"textSearchable":false,
"id":"type",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"multiSelect":null
},
{
"validationPattern":null,
"custom":false,
"length":254,
"label":"DUNS number",
"type":"shortText",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"shortText",
"internalOnly":false,
"default":null,
"localizable":false,
"textSearchable":false,
"id":"dunsNumber",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"multiSelect":null
},
{
"validationPattern":null,
"custom":false,
"length":254,
"label":"uniqueId",
"type":"shortText",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"shortText",
"internalOnly":false,
"default":null,
"localizable":false,
"textSearchable":false,
"id":"uniqueId",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"multiSelect":null
},
{
"validationPattern":null,
"custom":false,
"length":1,
"label":"Approval required",
"type":"checkbox",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"checkbox",
"internalOnly":false,
"default":true,
"localizable":false,
"textSearchable":false,
"id":"derivedApprovalRequired",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"multiSelect":null
},
{
"validationPattern":null,
"custom":false,
"length":254,
"label":"Description",
"type":"shortText",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"shortText",
"internalOnly":false,
"default":null,
"localizable":false,
"textSearchable":false,
"id":"description",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"multiSelect":null
},
{
"validationPattern":null,
"custom":false,
"length":254,
"label":"Name",
"type":"shortText",
"required":true,
"searchable":false,
"writable":true,
"uiEditorType":"shortText",
"internalOnly":false,
"default":null,
"localizable":false,
"textSearchable":false,
"id":"name",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"searchable"
],
"multiSelect":null
},
{
"validationPattern":null,
"custom":false,
"length":1,
"label":"active",
"type":"checkbox",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"checkbox",
"internalOnly":false,
"default":true,
"localizable":false,
"textSearchable":false,
"id":"active",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"multiSelect":null
},
{
"validationPattern":null,
"custom":false,
"length":0,
"label":"Customer type",
"type":"shortText",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"shortText",
"internalOnly":false,
"default":null,
"localizable":false,
"textSearchable":false,
"id":"derivedCustomerType",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"multiSelect":null
},
{
"validationPattern":null,
"custom":false,
"length":254,
"label":"taxReferenceNumber",
"type":"shortText",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"shortText",
"internalOnly":false,
"default":null,
"localizable":false,
"textSearchable":false,
"id":"taxReferenceNumber",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"multiSelect":null
},
{
"validationPattern":null,
"custom":false,
"length":254,
"label":"organizationLogo",
"type":"shortText",
"required":false,
"searchable":false,
"writable":true,
"uiEditorType":"shortText",
"internalOnly":false,
"default":null,
"localizable":false,
"textSearchable":false,
"id":"organizationLogo",
"dimension":false,
"editableAttributes":[
"textSearchable",
"multiSelect",
"dimension",
"internalOnly",
"default",
"label",
"required",
"searchable"
],
"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|
|------------------|------------------|
|200501|Invalid item type Id|
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