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
-
base(optional):
array base
Base type Details
-
count(optional):
integer
The count of items.
-
displayName(optional):
string
The display name of the item type
-
id(optional):
string
The ID of the item type.
-
shopperInputs(optional):
array shopperInputs
Shopper Inputs corresponding to the productType
-
specifications(optional):
array specifications
List of properties for user-defined item type.
-
variants(optional):
array variants
Variants of the product
Nested Schema : shopperInputs
Type:
array
Shopper Inputs corresponding to the productType
Show Source
Nested Schema : specifications
Type:
array
List of properties for user-defined item type.
Show Source
Nested Schema : items
Type:
Show Source
object
-
default(optional):
string
Default specification of product type.
- hidden(optional): boolean
-
id(optional):
string
ID of specification.
-
itemType(optional):
string
Item type for user-defined product.
-
label(optional):
string
Label for new item type.
-
length(optional):
integer
The length property of the variant
-
listingVariant(optional):
boolean
Whether listing should be done based on this variant.
-
localizable(optional):
boolean
Whether Localizable or not.
-
order(optional):
integer
Order count of item type.
-
required(optional):
boolean
Whether it is required or not.
-
type(optional):
string
Data type of variant.
-
uiEditorType(optional):
string
The UIEditorType property of the variant
-
variantBasedDisplay(optional):
boolean
Whether this variant based display should be allowed
-
writable(optional):
string
Whether writable or not.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
Id corresponding to the shopperInput
-
label(optional):
string
The display label of the shopperInput
-
name(optional):
string
The name of the shopperInput
-
promptText(optional):
string
The descriptive text for the shopperInput
-
required(optional):
boolean
Whether it is required or not.
-
type(optional):
string
Data type of shopperInput.
-
uiEditorType(optional):
string
The UIEditorType property of the shopperInput
-
values(optional):
array values
List of allowed values in case of Single Selection List type.
Nested Schema : values
Type:
array
List of allowed values in case of Single Selection List type.
Show Source
Nested Schema : items
Type:
Show Source
object
-
default(optional):
string
Default specification of product type.
- hidden(optional): boolean
-
id(optional):
string
ID of specification.
-
itemType(optional):
string
Item type for user-defined product.
-
label(optional):
string
Label for new item type.
-
length(optional):
integer
The length property of the variant
-
listingVariant(optional):
boolean
Whether listing should be done based on this variant.
-
localizable(optional):
boolean
Whether Localizable or not.
-
order(optional):
integer
Order count of item type.
-
required(optional):
boolean
Whether it is required or not.
-
type(optional):
string
Data type of variant.
-
uiEditorType(optional):
string
The UIEditorType property of the variant
-
validationPattern(optional):
string
Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.
-
variantBasedDisplay(optional):
boolean
Whether this variant based display should be allowed
-
writable(optional):
string
Whether writable or not.
Nested Schema : items
Type:
Show Source
object
-
default(optional):
string
Default specification of product type.
- hidden(optional): boolean
-
id(optional):
string
ID of specification.
-
itemType(optional):
string
Item type for user-defined product.
-
label(optional):
string
Label for new item type.
-
length(optional):
integer
The length property of the variant
-
listingVariant(optional):
boolean
Whether listing should be done based on this variant.
-
localizable(optional):
boolean
Whether Localizable or not.
-
order(optional):
integer
Order count of item type.
-
required(optional):
boolean
Whether it is required or not.
-
type(optional):
string
Data type of variant.
-
uiEditorType(optional):
string
The UIEditorType property of the variant
-
variantBasedDisplay(optional):
boolean
Whether this variant based display should be allowed
-
writable(optional):
string
Whether writable or not.
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,
"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,
"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,
"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,
"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,
"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,
"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,
"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,
"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,
"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,
"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,
"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,
"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,
"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,
"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