Jump to

• Request
• Response

updateSkuProperty

put

/ccadmin/v1/skuProperties/{id}

Update a SKU dynamic property with specified ID. **Requires the x-ccasset-language header so translated content can be set for a specific language.**

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID of the SKU property.

Header Parameters

• X-CCAsset-Language: string
  The asset language of the request

Body ()

Root Schema : updateSkuProperty_request

Type: object

Show Source

• id: string
  SKU dynamic property ID.
• productTypeId: string
  Product type ID

{
    "properties":{
        "id":{
            "description":"SKU dynamic property ID.",
            "type":"string"
        },
        "productTypeId":{
            "description":"Product type ID",
            "type":"string"
        }
    },
    "required":[
        "id",
        "productTypeId"
    ],
    "example":{
        "default":"newDefaultValue",
        "id":"upccode",
        "label":"New Label",
        "searchable":true,
        "productTypeId":"sampleProductType"
    }
}

Example:

{
    "default":"newDefaultValue",
    "id":"upccode",
    "label":"New Label",
    "searchable":true,
    "productTypeId":"sampleProductType"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateSkuProperty_response

Type: object

Show Source

• 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
  Whether the property is hidden from being displayed in the UI.
• 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.

{
    "properties":{
        "itemType":{
            "description":"The item type that the property is defined on. For example, if the product type is \"SampleType\" then this value would be \"sku-SampleType\".",
            "type":"string"
        },
        "hidden":{
            "description":"Whether the property is hidden from being displayed in the UI.",
            "type":"boolean"
        },
        "length":{
            "description":"Maximum length of the property value.",
            "type":"integer"
        },
        "variantBasedDisplay":{
            "description":"Whether a variant based display should be allowed.",
            "type":"boolean"
        },
        "label":{
            "description":"The display label of the property.",
            "type":"boolean"
        },
        "type":{
            "description":"The data type of the property. Possible values are shortText, longText, richText, number, date or checkbox.",
            "type":"string"
        },
        "searchable":{
            "description":"Whether the property is searchable on the storefront.",
            "type":"boolean"
        },
        "required":{
            "description":"Whether the property value is required.",
            "type":"boolean"
        },
        "writable":{
            "description":"Whether the property is writable.",
            "type":"boolean"
        },
        "internalOnly":{
            "description":"Flag to determine if the property is visible through only Admin or also Storefront.",
            "type":"boolean"
        },
        "uiEditorType":{
            "description":"Type of UI editor to show for the property. Possible values are shortText, longText, richText, number, date or checkbox.",
            "type":"string"
        },
        "default":{
            "description":"Default value of this property.",
            "type":"string"
        },
        "listingVariant":{
            "description":"Whether it is listing variant.",
            "type":"boolean"
        },
        "propertyType":{
            "description":"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.",
            "type":"string"
        },
        "localizable":{
            "description":"Flag indicating if the property value can be localized.",
            "type":"boolean"
        },
        "textSearchable":{
            "description":"Whether the property is text searchable on the storefront.",
            "type":"boolean"
        },
        "id":{
            "description":"ID of this SKU dynamic property.",
            "type":"string"
        },
        "dimension":{
            "description":"Allow property to be a search facet on the storefront.",
            "type":"boolean"
        },
        "editableAttributes":{
            "description":"Attributes of this property that can be edited.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "multiSelect":{
            "description":"Whether the property is a multi-select search facet.",
            "type":"boolean"
        },
        "order":{
            "description":"Relative order of the property among all of the SKU properties.",
            "type":"string"
        }
    }
}

Nested Schema : editableAttributes

Type: array

Attributes of this property that can be edited.

Show Source

• Array of: string

{
    "description":"Attributes of this property that can be edited.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

{
    "itemType":"sku-sampleProductType",
    "hidden":false,
    "length":254,
    "variantBasedDisplay":false,
    "label":"New Label",
    "type":"shortText",
    "required":false,
    "searchable":true,
    "writable":true,
    "internalOnly":false,
    "default":"newDefaultValue",
    "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
}

412 Response

ETag mismatch. Asset has been updated by another user.

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| |------------------|------------------| |20113|Property type can't be changed|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top