listItemTypes
get
/ccagent/v1/itemTypes
List Item Types. Get item type info and base type info of a list of item types.
Request
Supported Media Types
- application/json
Query Parameters
-
includeBase: boolean
Set to true to get base type details.
-
itemTypeIds(required): string
Comma separated list of item types to be returned
-
parent: string
Parent Type of current requested item type. It takes product as default parent for custom types.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listItemTypes_response
Type:
Show Source
object-
items:
array items
array of item types
Nested Schema : items
Type:
Show Source
object-
base:
array base
Base type Details
-
count:
integer
The count of items.
-
displayName:
string
The display name of the item type
-
id:
string
The ID of the item type.
-
shopperInputs:
array shopperInputs
Shopper Inputs corresponding to the productType
-
specifications:
array specifications
List of properties for user-defined item type.
-
variants:
array variants
Variants of the product
Nested Schema : shopperInputs
Type:
arrayShopper Inputs corresponding to the productType
Show Source
Nested Schema : specifications
Type:
arrayList of properties for user-defined item type.
Show Source
Nested Schema : items
Type:
Show Source
object-
default:
string
Default specification of product type.
- hidden: boolean
-
id:
string
ID of specification.
-
internalOnly:
boolean
Flag indicating if this specification is internal only.
-
itemType:
string
Item type for user-defined product.
-
label:
string
Label for new item type.
-
length:
integer
The length property of the variant
-
listingVariant:
boolean
Whether listing should be done based on this variant.
-
localizable:
boolean
Whether Localizable or not.
-
order:
integer
Order count of item type.
-
required:
boolean
Whether it is required or not.
-
type:
string
Data type of variant.
-
uiEditorType:
string
The UIEditorType property of the variant
-
variantBasedDisplay:
boolean
Whether this variant based display should be allowed
-
writable:
string
Whether writable or not.
Nested Schema : items
Type:
Show Source
object-
id:
string
Id corresponding to the shopperInput
-
label:
string
The display label of the shopperInput
-
name:
string
The name of the shopperInput
-
promptText:
string
The descriptive text for the shopperInput
-
required:
boolean
Whether it is required or not.
-
type:
string
Data type of shopperInput.
-
uiEditorType:
string
The UIEditorType property of the shopperInput
-
values:
array values
List of allowed values in case of Single Selection List type.
Nested Schema : values
Type:
arrayList of allowed values in case of Single Selection List type.
Show Source
Nested Schema : items
Type:
Show Source
object-
default:
string
Default specification of product type.
- hidden: boolean
-
id:
string
ID of specification.
-
internalOnly:
boolean
Flag indicating if this specification is internal only.
-
itemType:
string
Item type for user-defined product.
-
label:
string
Label for new item type.
-
length:
integer
The length property of the variant
-
listingVariant:
boolean
Whether listing should be done based on this variant.
-
localizable:
boolean
Whether Localizable or not.
-
order:
integer
Order count of item type.
-
required:
boolean
Whether it is required or not.
-
type:
string
Data type of variant.
-
uiEditorType:
string
The UIEditorType property of the variant
-
validationPattern:
string
Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.
-
variantBasedDisplay:
boolean
Whether this variant based display should be allowed
-
writable:
string
Whether writable or not.
Nested Schema : items
Type:
Show Source
object-
default:
string
Default specification of product type.
- hidden: boolean
-
id:
string
ID of specification.
-
internalOnly:
boolean
Flag indicating if this specification is internal only.
-
itemType:
string
Item type for user-defined product.
-
label:
string
Label for new item type.
-
length:
integer
The length property of the variant
-
listingVariant:
boolean
Whether listing should be done based on this variant.
-
localizable:
boolean
Whether Localizable or not.
-
order:
integer
Order count of item type.
-
required:
boolean
Whether it is required or not.
-
type:
string
Data type of variant.
-
uiEditorType:
string
The UIEditorType property of the variant
-
variantBasedDisplay:
boolean
Whether this variant based display should be allowed
-
writable:
string
Whether writable or not.
Example Response (application/json)
[
{
"shopperInputs":[
{
"uiEditorType":"shortText",
"translations":{
"1":"shopperInputTranslation:giftMessage_en"
},
"name":"Gift Message",
"label":"Gift Message",
"id":"giftMessage",
"promptText":"Enter the gift message",
"type":"shortText",
"required":false,
"enumValues":[
]
},
{
"uiEditorType":"richText",
"translations":{
"1":"shopperInputTranslation:giftMessageDetails_en"
},
"name":"Gift Message Details",
"label":"Gift Message Description",
"id":"giftMessageDetails",
"promptText":"Enter the gift message details",
"type":"richText",
"required":false,
"enumValues":[
]
},
{
"uiEditorType":"number",
"translations":{
"1":"shopperInputTranslation:giftMessageNumber_en"
},
"name":"Gift Message Number",
"label":"Gift Message Number",
"id":"giftMessageNumber",
"promptText":"Enter the gift number",
"type":"number",
"required":true,
"enumValues":[
]
},
{
"uiEditorType":"checkbox",
"translations":{
"1":"shopperInputTranslation:giftMessageCheckbox_en"
},
"name":"Gift Message Checkbox",
"label":"Gift Message Checkbox",
"id":"giftMessageCheckbox",
"promptText":"Select the checkbox",
"type":"checkbox",
"required":true,
"enumValues":[
]
},
{
"uiEditorType":"date",
"translations":{
"1":"shopperInputTranslation:giftMessageDate_en"
},
"name":"Gift Message Date",
"label":"Gift Message Date",
"id":"giftMessageDate",
"promptText":"Enter the date",
"type":"date",
"required":true,
"enumValues":[
]
},
{
"uiEditorType":"singleSelectionList",
"translations":{
"1":"shopperInputTranslation:giftMessageSelection_en"
},
"name":"Gift Message Selection",
"label":"Gift Message Selection",
"id":"giftMessageSelection",
"promptText":"Select",
"type":"enumerated",
"required":true,
"enumValues":[
"J.Crew",
"OshKosh B'Gosh",
"Abercrombie & Fitch"
]
}
],
"id":"sku",
"specifications":[
{
"itemType":"sku",
"hidden":false,
"length":254,
"variantBasedDisplay":false,
"label":"baseLevelSkuProperty",
"type":"shortText",
"required":false,
"writable":true,
"default":null,
"listingVariant":false,
"propertyType":"sku-base",
"localizable":false,
"id":"baseLevelSkuProperty",
"order":null
}
],
"base":[
{
"itemType":"sku",
"hidden":false,
"length":254,
"variantBasedDisplay":false,
"label":"Name",
"type":"shortText",
"required":false,
"writable":true,
"uiEditorType":null,
"internalOnly":false,
"default":null,
"listingVariant":false,
"localizable":true,
"id":"displayName",
"order":"-11"
},
{
"itemType":"sku",
"hidden":false,
"length":165,
"variantBasedDisplay":false,
"label":"Id",
"type":"shortText",
"required":false,
"writable":false,
"uiEditorType":null,
"internalOnly":false,
"default":null,
"listingVariant":false,
"localizable":false,
"id":"id",
"order":"-4"
},
{
"itemType":"sku",
"hidden":false,
"length":1,
"variantBasedDisplay":false,
"label":"Active",
"type":"checkbox",
"required":false,
"writable":true,
"uiEditorType":null,
"internalOnly":false,
"default":true,
"listingVariant":false,
"localizable":false,
"id":"active",
"order":"50"
}
]
},
{
"id":"sku-MensApparel",
"specifications":[
{
"itemType":"sku-MensApparel",
"hidden":false,
"length":254,
"variantBasedDisplay":false,
"label":"customLevelSkuProperty",
"type":"shortText",
"required":false,
"writable":true,
"default":null,
"listingVariant":false,
"propertyType":"sku-custom",
"localizable":false,
"id":"customLevelSkuProperty",
"order":null
},
{
"itemType":"sku-MensApparel",
"localizedValues":null,
"hidden":false,
"values":[
"Beige",
"Black",
"Blue",
"Brown",
"Camo",
"Dark Worn",
"Gray",
"Green",
"Medium Worn",
"Navy",
"Orange",
"Red",
"Tan",
"White"
],
"length":19,
"variantBasedDisplay":false,
"label":"Color",
"type":"enumerated",
"required":false,
"writable":true,
"uiEditorType":null,
"internalOnly":false,
"default":null,
"listingVariant":false,
"propertyType":"variant",
"localizable":false,
"id":"color",
"order":null
},
{
"itemType":"sku-MensApparel",
"localizedValues":null,
"hidden":false,
"values":[
"Small",
"Medium",
"Large",
"X-Large"
],
"length":19,
"variantBasedDisplay":false,
"label":"Size",
"type":"enumerated",
"required":false,
"writable":true,
"uiEditorType":null,
"internalOnly":false,
"default":null,
"listingVariant":false,
"propertyType":"variant",
"localizable":false,
"id":"size",
"order":null
}
],
"base":[
{
"itemType":"sku",
"hidden":false,
"length":254,
"variantBasedDisplay":false,
"label":"Name",
"type":"shortText",
"required":false,
"writable":true,
"uiEditorType":null,
"internalOnly":false,
"default":null,
"listingVariant":false,
"localizable":true,
"id":"displayName",
"order":"-11"
},
{
"itemType":"sku",
"hidden":false,
"length":165,
"variantBasedDisplay":false,
"label":"Id",
"type":"shortText",
"required":false,
"writable":false,
"uiEditorType":null,
"internalOnly":false,
"default":null,
"listingVariant":false,
"localizable":false,
"id":"id",
"order":"-4"
},
{
"itemType":"sku",
"hidden":false,
"length":1,
"variantBasedDisplay":false,
"label":"Active",
"type":"checkbox",
"required":false,
"writable":true,
"uiEditorType":null,
"internalOnly":false,
"default":true,
"listingVariant":false,
"localizable":false,
"id":"active",
"order":"50"
},
{
"itemType":"sku",
"hidden":false,
"length":254,
"variantBasedDisplay":false,
"label":"baseLevelSkuProperty",
"type":"shortText",
"required":false,
"writable":true,
"default":null,
"listingVariant":false,
"propertyType":"sku-base",
"localizable":false,
"id":"baseLevelSkuProperty",
"order":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|
|------------------|------------------|
|20583|Could not find item type|
|20688|Parent Id does not match Item Type|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code