getSkuProperties
get
/ccadmin/v1/skuProperties
Get a list of SKU properties. For "product", this will be the base properties on a SKU. For any other type, this will be the type-specific SKU properties.
Request
Supported Media Types
- application/json
Query Parameters
-
productTypeId: string
Product type ID for which the SKU properties will be retrieved. If this is "product", the base properties will be returned.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds. This will return an empty result if there are no dynamic SKU properties.
Root Schema : getSkuProperties_response
Type:
Show Source
object
-
items(optional):
array items
An array containing the list of sku properties for a product type
Nested Schema : items
Type:
array
An array containing the list of sku properties for a product type
Show Source
Nested Schema : items
Type:
Show Source
object
-
default(optional):
string
Default value of this property.
-
dimension(optional):
boolean
Allow property to be a search facet on the storefront.
-
editableAttributes(optional):
array editableAttributes
Attributes of this property that can be edited.
- hidden(optional): boolean
-
id(optional):
string
ID of this SKU dynamic property.
-
internalOnly(optional):
boolean
Flag to determine if the property is visible through only Admin or also Storefront.
-
itemType(optional):
string
The item type that the property is defined on. For example, if the product type is "SampleType" then this value would be "sku-SampleType".
-
label(optional):
boolean
The display label of the property.
-
length(optional):
integer
Maximum length of the property value.
-
listingVariant(optional):
boolean
Whether it is listing variant.
-
localizable(optional):
boolean
Flag indicating if the property value can be localized.
-
multiSelect(optional):
boolean
Whether the property is a multi-select search facet.
-
order(optional):
string
Relative order of the property among all of the SKU properties.
-
propertyType(optional):
string
Type of the property. It could be sku-custom for a custom level sku property or sku-base for a sku property defined at base product level.
-
required(optional):
boolean
Whether the property value is required.
-
searchable(optional):
boolean
Whether the property is searchable on the storefront.
-
textSearchable(optional):
boolean
Whether the property is text searchable on the storefront.
-
type(optional):
string
The data type of the property. Possible values are shortText, longText, richText, number, date or checkbox.
-
uiEditorType(optional):
string
Type of UI editor to show for the property. Possible values are shortText, longText, richText, number, date or checkbox.
-
variantBasedDisplay(optional):
boolean
Whether a variant based display should be allowed.
-
writable(optional):
boolean
Whether the property is writable.
Nested Schema : editableAttributes
Type:
array
Attributes of this property that can be edited.
Show Source
Example Response (application/json)
{
"items":[
{
"itemType":"sku-sampleProductType",
"hidden":false,
"length":254,
"variantBasedDisplay":false,
"label":"Color Description",
"type":"shortText",
"required":false,
"searchable":false,
"writable":true,
"internalOnly":false,
"default":"defaultValue",
"listingVariant":false,
"propertyType":"sku-custom",
"localizable":false,
"textSearchable":false,
"id":"x_colorDescription",
"dimension":false,
"editableAttributes":[
"dimension",
"multiSelect",
"textSearchable",
"default",
"internalOnly",
"order",
"listingVariant",
"hidden",
"label",
"required",
"variantBasedDisplay",
"searchable"
],
"multiSelect":false,
"order":null
}
]
}
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