Jump to

• Request
• Response

deleteItemTypeProperty

delete

/ccadmin/v1/itemTypes/{itemTypeId}/properties/{propertyId}

Deletes a previously created dynamic property with the given property ID and item type. Only supported for a type of category

Request

Supported Media Types

• application/json

Path Parameters

• itemTypeId: string
  ID of the item type from which to remove the property.
• propertyId: string
  ID of the dynamic property to remove.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Dynamic property successfully deleted.

Body ()

Root Schema : getItemType_response

Type: object

Show Source

• displayName(optional): string
  Display name of item type.
• id(optional): string
  ID of item type.
• propertiesOrder(optional): array propertiesOrder
  List of properties in ascending order
• specifications(optional): array specifications
  List of specifications for user-defined item type.

{
    "properties":{
        "propertiesOrder":{
            "description":"List of properties in ascending order",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "displayName":{
            "description":"Display name of item type.",
            "type":"string"
        },
        "id":{
            "description":"ID of item type.",
            "type":"string"
        },
        "specifications":{
            "description":"List of specifications for user-defined item type.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "validationPattern":{
                        "description":"Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.",
                        "type":"string"
                    },
                    "readAccessRight":{
                        "description":"Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)",
                        "type":"string"
                    },
                    "securityMaskingValue":{
                        "description":"A value to return if the read fails the security check and the readSecurityLevel is ignore.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of specification.",
                        "type":"string"
                    },
                    "writeSecurityLevel":{
                        "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that writes will fail silently.  Deny means that attempts to write the property will result in an error.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether specification is required or not.",
                        "type":"number"
                    },
                    "writable":{
                        "description":"Whether writable or not.",
                        "type":"string"
                    },
                    "default":{
                        "description":"Default value of specificaion.",
                        "type":"string"
                    },
                    "textSearchable":{
                        "description":"Whether text is searchable or not.",
                        "type":"boolean"
                    },
                    "writeRole":{
                        "description":"Can be set to a single role id, in which case a user must have that role in order to write the property.",
                        "type":"string"
                    },
                    "shopperWritable":{
                        "description":"If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile. ",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of specification.",
                        "type":"string"
                    },
                    "dimension":{
                        "description":"Dimension of specification.",
                        "type":"string"
                    },
                    "editableAttributes":{
                        "description":"List of editable properties",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "readRole":{
                        "description":"Can be set to a single role id, in which case a user must have that role in order to read the property.",
                        "type":"string"
                    },
                    "readSecurityLevel":{
                        "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute.  Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error.  Deny security is only available on custom properties.",
                        "type":"string"
                    },
                    "length":{
                        "description":"Length of type supported.",
                        "type":"boolean"
                    },
                    "shopperReadable":{
                        "description":"If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.",
                        "type":"string"
                    },
                    "label":{
                        "description":"Label for new item type.",
                        "type":"string"
                    },
                    "writeAccessRight":{
                        "description":"Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)",
                        "type":"string"
                    },
                    "searchable":{
                        "description":"Whether item searchable or not.",
                        "type":"boolean"
                    },
                    "internalOnly":{
                        "description":"Whether specification is internal.",
                        "type":"boolean"
                    },
                    "uiEditorType":{
                        "description":"The UI editor type.",
                        "type":"string"
                    },
                    "localizable":{
                        "description":"Whether specification is localizable or not.",
                        "type":"boolean"
                    },
                    "multiSelect":{
                        "description":"Whether multi-select search facet or not.",
                        "type":"number"
                    }
                }
            }
        }
    }
}

Nested Schema : propertiesOrder

Type: array

List of properties in ascending order

Show Source

• Array of: string

{
    "description":"List of properties in ascending order",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : specifications

Type: array

List of specifications for user-defined item type.

Show Source

• Array of: object items

{
    "description":"List of specifications for user-defined item type.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "validationPattern":{
                "description":"Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.",
                "type":"string"
            },
            "readAccessRight":{
                "description":"Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)",
                "type":"string"
            },
            "securityMaskingValue":{
                "description":"A value to return if the read fails the security check and the readSecurityLevel is ignore.",
                "type":"string"
            },
            "type":{
                "description":"Data type of specification.",
                "type":"string"
            },
            "writeSecurityLevel":{
                "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that writes will fail silently.  Deny means that attempts to write the property will result in an error.",
                "type":"string"
            },
            "required":{
                "description":"Whether specification is required or not.",
                "type":"number"
            },
            "writable":{
                "description":"Whether writable or not.",
                "type":"string"
            },
            "default":{
                "description":"Default value of specificaion.",
                "type":"string"
            },
            "textSearchable":{
                "description":"Whether text is searchable or not.",
                "type":"boolean"
            },
            "writeRole":{
                "description":"Can be set to a single role id, in which case a user must have that role in order to write the property.",
                "type":"string"
            },
            "shopperWritable":{
                "description":"If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile. ",
                "type":"string"
            },
            "id":{
                "description":"ID of specification.",
                "type":"string"
            },
            "dimension":{
                "description":"Dimension of specification.",
                "type":"string"
            },
            "editableAttributes":{
                "description":"List of editable properties",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "readRole":{
                "description":"Can be set to a single role id, in which case a user must have that role in order to read the property.",
                "type":"string"
            },
            "readSecurityLevel":{
                "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute.  Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error.  Deny security is only available on custom properties.",
                "type":"string"
            },
            "length":{
                "description":"Length of type supported.",
                "type":"boolean"
            },
            "shopperReadable":{
                "description":"If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.",
                "type":"string"
            },
            "label":{
                "description":"Label for new item type.",
                "type":"string"
            },
            "writeAccessRight":{
                "description":"Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)",
                "type":"string"
            },
            "searchable":{
                "description":"Whether item searchable or not.",
                "type":"boolean"
            },
            "internalOnly":{
                "description":"Whether specification is internal.",
                "type":"boolean"
            },
            "uiEditorType":{
                "description":"The UI editor type.",
                "type":"string"
            },
            "localizable":{
                "description":"Whether specification is localizable or not.",
                "type":"boolean"
            },
            "multiSelect":{
                "description":"Whether multi-select search facet or not.",
                "type":"number"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• default(optional): string
  Default value of specificaion.
• dimension(optional): string
  Dimension of specification.
• editableAttributes(optional): array editableAttributes
  List of editable properties
• id(optional): string
  ID of specification.
• internalOnly(optional): boolean
  Whether specification is internal.
• label(optional): string
  Label for new item type.
• length(optional): boolean
  Length of type supported.
• localizable(optional): boolean
  Whether specification is localizable or not.
• multiSelect(optional): number
  Whether multi-select search facet or not.
• readAccessRight(optional): string
  Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)
• readRole(optional): string
  Can be set to a single role id, in which case a user must have that role in order to read the property.
• readSecurityLevel(optional): string
  Can be set to "deny" or "ignore", with "ignore" being the default behavior. Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute. Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error. Deny security is only available on custom properties.
• required(optional): number
  Whether specification is required or not.
• searchable(optional): boolean
  Whether item searchable or not.
• securityMaskingValue(optional): string
  A value to return if the read fails the security check and the readSecurityLevel is ignore.
• shopperReadable(optional): string
  If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.
• shopperWritable(optional): string
  If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile.
• textSearchable(optional): boolean
  Whether text is searchable or not.
• type(optional): string
  Data type of specification.
• uiEditorType(optional): string
  The UI editor type.
• validationPattern(optional): string
  Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.
• writable(optional): string
  Whether writable or not.
• writeAccessRight(optional): string
  Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)
• writeRole(optional): string
  Can be set to a single role id, in which case a user must have that role in order to write the property.
• writeSecurityLevel(optional): string
  Can be set to "deny" or "ignore", with "ignore" being the default behavior. Ignore means that writes will fail silently. Deny means that attempts to write the property will result in an error.

{
    "type":"object",
    "properties":{
        "validationPattern":{
            "description":"Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.",
            "type":"string"
        },
        "readAccessRight":{
            "description":"Can be set to a single access right id, in which case a user must have that access right in order to read the property. (If readRole is also set, then a user can have the role OR the access right in order to access.)",
            "type":"string"
        },
        "securityMaskingValue":{
            "description":"A value to return if the read fails the security check and the readSecurityLevel is ignore.",
            "type":"string"
        },
        "type":{
            "description":"Data type of specification.",
            "type":"string"
        },
        "writeSecurityLevel":{
            "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that writes will fail silently.  Deny means that attempts to write the property will result in an error.",
            "type":"string"
        },
        "required":{
            "description":"Whether specification is required or not.",
            "type":"number"
        },
        "writable":{
            "description":"Whether writable or not.",
            "type":"string"
        },
        "default":{
            "description":"Default value of specificaion.",
            "type":"string"
        },
        "textSearchable":{
            "description":"Whether text is searchable or not.",
            "type":"boolean"
        },
        "writeRole":{
            "description":"Can be set to a single role id, in which case a user must have that role in order to write the property.",
            "type":"string"
        },
        "shopperWritable":{
            "description":"If set to true, Storefront users will be able to bypass any role or access right security when writing the property on their own profile. ",
            "type":"string"
        },
        "id":{
            "description":"ID of specification.",
            "type":"string"
        },
        "dimension":{
            "description":"Dimension of specification.",
            "type":"string"
        },
        "editableAttributes":{
            "description":"List of editable properties",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "readRole":{
            "description":"Can be set to a single role id, in which case a user must have that role in order to read the property.",
            "type":"string"
        },
        "readSecurityLevel":{
            "description":"Can be set to \"deny\" or \"ignore\", with \"ignore\" being the default behavior.  Ignore means that reads will return a masking value rather than the real value: null, default value, or a value set via the securityMaskingValue attribute.  Deny means that the property will disappear entirely from responses and direct attempts to read it will result in an error.  Deny security is only available on custom properties.",
            "type":"string"
        },
        "length":{
            "description":"Length of type supported.",
            "type":"boolean"
        },
        "shopperReadable":{
            "description":"If set to true, Storefront users will be able to bypass any role or access right security when reading the property on their own profile.",
            "type":"string"
        },
        "label":{
            "description":"Label for new item type.",
            "type":"string"
        },
        "writeAccessRight":{
            "description":"Can be set to a single access right id, in which case a user must have that access right in order to write the property. (If writeRole is also set, then a user can have the role OR the access right in order to write the property.)",
            "type":"string"
        },
        "searchable":{
            "description":"Whether item searchable or not.",
            "type":"boolean"
        },
        "internalOnly":{
            "description":"Whether specification is internal.",
            "type":"boolean"
        },
        "uiEditorType":{
            "description":"The UI editor type.",
            "type":"string"
        },
        "localizable":{
            "description":"Whether specification is localizable or not.",
            "type":"boolean"
        },
        "multiSelect":{
            "description":"Whether multi-select search facet or not.",
            "type":"number"
        }
    }
}

Nested Schema : editableAttributes

Type: array

List of editable properties

Show Source

• Array of: string

{
    "description":"List of editable properties",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top