getSkuProperty
get
/ccadmin/v1/skuProperties/{id}
Get details about a SKU dynamic property using the specific property ID.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
ID of the SKU dynamic property.
Query Parameters
-
productTypeId(required): string
Product type ID for the SKU type on which the property is defined.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds. For example, /skuProperties/upccode?productTypeId=sampleProductType
Root Schema : getSkuProperty_response
Type:
Show Source
object
-
default:
string
Default value of this property.
-
dimension:
boolean
Allow property to be a search facet on the storefront.
-
editableAttributes:
array editableAttributes
Attributes of this property that can be edited.
- hidden: boolean
-
id:
string
ID of this SKU dynamic property.
-
internalOnly:
boolean
Flag to determine if the property is visible through only Admin or also Storefront.
-
itemType:
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:
boolean
The display label of the property.
-
length:
integer
Maximum length of the property value.
-
listingVariant:
boolean
Whether it is listing variant.
-
localizable:
boolean
Flag indicating if the property value can be localized.
-
multiSelect:
boolean
Whether the property is a multi-select search facet.
-
order:
string
Relative order of the property among all of the SKU properties.
-
propertyType:
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:
boolean
Whether the property value is required.
-
searchable:
boolean
Whether the property is searchable on the storefront.
-
textSearchable:
boolean
Whether the property is text searchable on the storefront.
-
type:
string
The data type of the property. Possible values are shortText, longText, richText, number, date or checkbox.
-
uiEditorType:
string
Type of UI editor to show for the property. Possible values are shortText, longText, richText, number, date or checkbox.
-
variantBasedDisplay:
boolean
Whether a variant based display should be allowed.
-
writable:
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)
{
"itemType":"sku-sampleProductType",
"hidden":false,
"length":254,
"variantBasedDisplay":false,
"label":"UpcCode",
"type":"shortText",
"required":false,
"searchable":false,
"writable":true,
"internalOnly":false,
"default":"defaultValue",
"listingVariant":false,
"propertyType":"sku-custom",
"localizable":false,
"textSearchable":false,
"id":"upccode",
"dimension":false,
"editableAttributes":[
"dimension",
"multiSelect",
"textSearchable",
"default",
"internalOnly",
"order",
"listingVariant",
"hidden",
"label",
"required",
"variantBasedDisplay",
"searchable"
],
"multiSelect":false
}
Default Response
The error response
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:
array
An 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