getMetadata
get
/ccadmin/v1/metadata/{id}
Get Metadata. Gets the properties for the following item types by ID: product, category, layout and seoMetaInfo. Optionally takes the x-ccasset-language header to get translated content in another language.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the itemType.
Query Parameters
-
layoutName(optional): string
String of the layout name to retrive, iff the item is a layout.
-
showHidden(optional): boolean
Boolean flag to show hidden properties.
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 : getMetadata_response
Type:
Show Source
object
-
items(optional):
array items
An array of metadata/ properties information for an item descriptor.
Nested Schema : items
Type:
array
An array of metadata/ properties information for an item descriptor.
Show Source
Nested Schema : items
Type:
Show Source
object
-
default(optional):
string
Default value of the property.
-
dimension(optional):
string
A flag indicating if the property is a dimensional property. Value is true for properties like width, height, length etc.
-
editableAttributes(optional):
array editableAttributes
List of attributes of the property which can be edited from UI.
- hidden(optional): boolean
-
id(optional):
string
ID of the property.
-
internalOnly(optional):
string
Indicates if the property is for internal use only, thus it will not be displayed on the storefront.
-
itemType(optional):
string
This property is the item type the property belongs to.
-
label(optional):
string
Label for the property.
-
order(optional):
integer
The display order of the property.
-
required(optional):
boolean
A flag indicating if this property is required.
-
searchable(optional):
boolean
A flag indicating if the property is searchable.
-
textSearchable(optional):
boolean
A flag indicating if the text of the property is searchable.
-
type(optional):
string
Broadly classified type of the property. For example, whether the property is of type number, text, date etc.
-
wildcardSearchable(optional):
boolean
Flag indicating if the property is searchable using wildcards.
-
writable(optional):
boolean
A flag indicating if the property is editable.
Nested Schema : editableAttributes
Type:
array
List of attributes of the property which can be edited from UI.
Show Source
Example Response (application/json)
[
{
"itemType":"product",
"hidden":false,
"length":1,
"variantBasedDisplay":false,
"label":"Discountable",
"type":"checkbox",
"required":false,
"searchable":false,
"writable":null,
"internalOnly":false,
"uiEditorType":null,
"default":true,
"listingVariant":false,
"localizable":false,
"textSearchable":false,
"id":"discountable",
"dimension":false,
"editableAttributes":[
"internalOnly",
"default",
"listingVariant",
"hidden",
"variantBasedDisplay",
"textSearchable",
"label",
"dimension",
"required",
"searchable",
"order",
"multiSelect"
],
"order":"-2",
"multiSelect":null
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":true,
"label":"Name",
"type":"shortText",
"required":true,
"searchable":true,
"writable":"true",
"internalOnly":null,
"default":null,
"textSearchable":true,
"id":"displayName",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"wildcardSearchable",
"searchable"
],
"order":"0"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":null,
"label":"Product Number",
"type":"shortText",
"required":true,
"searchable":null,
"writable":false,
"internalOnly":null,
"default":"p1815",
"textSearchable":null,
"id":"productNumber",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"wildcardSearchable",
"searchable"
],
"order":"10"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":true,
"label":"Description",
"type":"shortText",
"required":false,
"searchable":true,
"writable":"true",
"internalOnly":null,
"default":"A Cloud Lake Product.",
"textSearchable":true,
"id":"description",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"required",
"wildcardSearchable",
"searchable"
],
"order":"10"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":null,
"label":"Brand",
"type":"shortText",
"required":false,
"searchable":null,
"writable":"true",
"internalOnly":null,
"default":null,
"textSearchable":null,
"id":"brand",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"required",
"wildcardSearchable",
"searchable"
],
"order":"15"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":null,
"label":"Default List Price",
"type":"currency",
"required":true,
"searchable":true,
"writable":"true",
"internalOnly":null,
"default":null,
"textSearchable":null,
"id":"listPrice",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"wildcardSearchable",
"searchable"
],
"order":"20"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":null,
"label":"Default Sale Price",
"type":"currency",
"required":false,
"searchable":true,
"writable":"true",
"internalOnly":null,
"default":null,
"textSearchable":null,
"id":"salePrice",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"required",
"wildcardSearchable",
"searchable"
],
"order":"20"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":null,
"label":"Product Code for US Taxes",
"type":"shortText",
"required":false,
"searchable":null,
"writable":"true",
"internalOnly":null,
"default":null,
"textSearchable":null,
"id":"taxCode",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"required",
"wildcardSearchable",
"searchable"
],
"order":"25"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":true,
"label":"Long Description",
"type":"shortText",
"required":false,
"searchable":true,
"writable":"true",
"internalOnly":null,
"default":null,
"textSearchable":true,
"id":"longDescription",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"required",
"wildcardSearchable",
"searchable"
],
"order":"30"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":true,
"label":"Active",
"type":"checkbox",
"required":false,
"searchable":true,
"writable":"true",
"internalOnly":null,
"default":null,
"textSearchable":true,
"id":"active",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"required",
"wildcardSearchable",
"searchable"
],
"order":"50"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":null,
"label":"Arrival Date",
"type":"date",
"required":false,
"searchable":null,
"writable":"true",
"internalOnly":null,
"default":null,
"textSearchable":null,
"id":"arrivalDate",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"required",
"wildcardSearchable",
"searchable"
],
"order":"60"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":true,
"label":"Height",
"type":"number",
"required":true,
"searchable":true,
"writable":"true",
"internalOnly":false,
"default":4,
"textSearchable":true,
"id":"height",
"dimension":true,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"required",
"wildcardSearchable",
"searchable"
],
"order":"70"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":null,
"label":"Length",
"type":"number",
"required":false,
"searchable":null,
"writable":"true",
"internalOnly":null,
"default":null,
"textSearchable":null,
"id":"length",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"required",
"wildcardSearchable",
"searchable"
],
"order":"80"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":null,
"label":"Width",
"type":"number",
"required":false,
"searchable":false,
"writable":"true",
"internalOnly":false,
"default":6,
"textSearchable":false,
"id":"width",
"dimension":false,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"required",
"wildcardSearchable",
"searchable"
],
"order":"90"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":null,
"label":"Weight",
"type":"number",
"required":false,
"searchable":null,
"writable":"true",
"internalOnly":null,
"default":null,
"textSearchable":null,
"id":"weight",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"required",
"wildcardSearchable",
"searchable"
],
"order":"100"
},
{
"itemType":"product",
"hidden":false,
"wildcardSearchable":null,
"label":"Order Limit",
"type":"digit",
"required":false,
"searchable":null,
"writable":"true",
"internalOnly":null,
"default":null,
"textSearchable":null,
"id":"orderLimit",
"dimension":null,
"editableAttributes":[
"textSearchable",
"dimension",
"internalOnly",
"default",
"order",
"hidden",
"label",
"required",
"wildcardSearchable",
"searchable"
],
"order":"110"
},
{
"itemType":"product",
"hidden":false,
"length":0,
"variantBasedDisplay":null,
"label":"salePrices",
"type":"currencyMap",
"required":false,
"searchable":false,
"writable":true,
"internalOnly":null,
"default":{
},
"listingVariant":null,
"localizable":false,
"textSearchable":false,
"id":"salePrices",
"dimension":false,
"editableAttributes":[
"dimension",
"multiSelect",
"textSearchable",
"default",
"internalOnly",
"order",
"listingVariant",
"hidden",
"label",
"required",
"variantBasedDisplay",
"searchable"
],
"multiSelect":null,
"order":null
},
{
"itemType":"product",
"hidden":false,
"length":0,
"variantBasedDisplay":null,
"label":"shippingSurcharges",
"type":"currencyMap",
"required":false,
"searchable":false,
"writable":true,
"internalOnly":null,
"default":{
},
"listingVariant":null,
"localizable":false,
"textSearchable":false,
"id":"shippingSurcharges",
"dimension":false,
"editableAttributes":[
"dimension",
"multiSelect",
"textSearchable",
"default",
"internalOnly",
"order",
"listingVariant",
"hidden",
"label",
"required",
"variantBasedDisplay",
"searchable"
],
"multiSelect":null,
"order":null
},
{
"itemType":"product",
"hidden":false,
"length":0,
"variantBasedDisplay":null,
"label":"listPrices",
"type":"currencyMap",
"required":false,
"searchable":false,
"writable":true,
"internalOnly":null,
"default":{
},
"listingVariant":null,
"localizable":false,
"textSearchable":false,
"id":"listPrices",
"dimension":false,
"editableAttributes":[
"dimension",
"multiSelect",
"textSearchable",
"default",
"internalOnly",
"order",
"listingVariant",
"hidden",
"label",
"required",
"variantBasedDisplay",
"searchable"
],
"multiSelect":null,
"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|
|------------------|------------------|
|33013|Get ItemDescriptor Error|
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