getMetadata
get
/ccstore/v1/metadata/{id}
Get Metadata. Get the metadata for an item type
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID of the file.
Query Parameters
-
dynamicOnly(optional): boolean
Indicates what type of properties to return. If set to true, only dynamic properties will be returned, otherwise all properties will be returned. Only supported for the 'order' item type.
-
filterByShopperContext(optional): string
If set to true, filters the dynamic properties that are related to shopper context
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",
"length":254,
"label":"Name",
"type":"shortText",
"required":true,
"searchable":true,
"uiEditorType":null,
"default":null,
"textSearchable":true,
"id":"displayName",
"dimension":null,
"multiSelect":true,
"order":"0"
},
{
"itemType":"product",
"length":165,
"label":"Product ID",
"type":"shortText",
"required":true,
"searchable":null,
"uiEditorType":null,
"default":"",
"textSearchable":null,
"id":"id",
"dimension":null,
"multiSelect":null,
"order":"10"
}
]
Default Response
The error response
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