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.

Header Parameters

• X-CC-Workset(optional): string
  The ID of the workset that this change will appear in. If this header is missing, the change will be made in the default workset.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Dynamic property successfully deleted.

Body ()

Root Schema : getItemType_response

Type: object

Show Source

• base(optional): array base
  Base type Details
• count(optional): integer
  The count of items.
• displayName(optional): string
  The display name of the item type
• id(optional): string
  The ID of the item type.
• shopperInputs(optional): array shopperInputs
  Shopper Inputs corresponding to the productType
• specifications(optional): array specifications
  List of properties for user-defined item type.
• variants(optional): array variants
  Variants of the product

{
    "properties":{
        "shopperInputs":{
            "description":"Shopper Inputs corresponding to the productType",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "uiEditorType":{
                        "description":"The UIEditorType property of the shopperInput",
                        "type":"string"
                    },
                    "values":{
                        "description":"List of allowed values in case of Single Selection List type.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "name":{
                        "description":"The name of the shopperInput",
                        "type":"string"
                    },
                    "label":{
                        "description":"The display label of the shopperInput",
                        "type":"string"
                    },
                    "id":{
                        "description":"Id corresponding to the shopperInput",
                        "type":"string"
                    },
                    "promptText":{
                        "description":"The descriptive text for the shopperInput",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of shopperInput.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether it is required or not.",
                        "type":"boolean"
                    }
                }
            }
        },
        "displayName":{
            "description":"The display name of the item type",
            "type":"string"
        },
        "count":{
            "description":"The count of items.",
            "type":"integer"
        },
        "id":{
            "description":"The ID of the item type.",
            "type":"string"
        },
        "variants":{
            "description":"Variants of the product",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "itemType":{
                        "description":"Item type for user-defined product.",
                        "type":"string"
                    },
                    "hidden":{
                        "description":"Whether item is hidden.",
                        "type":"boolean"
                    },
                    "variantBasedDisplay":{
                        "description":"Whether this variant based display should be allowed ",
                        "type":"boolean"
                    },
                    "length":{
                        "description":"The length property of the variant",
                        "type":"integer"
                    },
                    "label":{
                        "description":"Label for new item type.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of variant.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether it is required or not.",
                        "type":"boolean"
                    },
                    "writable":{
                        "description":"Whether writable or not.",
                        "type":"string"
                    },
                    "uiEditorType":{
                        "description":"The UIEditorType property of the variant",
                        "type":"string"
                    },
                    "default":{
                        "description":"Default specification of product type.",
                        "type":"string"
                    },
                    "listingVariant":{
                        "description":"Whether listing should be done based on this variant.",
                        "type":"boolean"
                    },
                    "localizable":{
                        "description":"Whether Localizable or not.",
                        "type":"boolean"
                    },
                    "id":{
                        "description":"ID of specification.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Order count of item type.",
                        "type":"integer"
                    }
                }
            }
        },
        "specifications":{
            "description":"List of properties 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"
                    },
                    "itemType":{
                        "description":"Item type for user-defined product.",
                        "type":"string"
                    },
                    "hidden":{
                        "description":"Whether item is hidden.",
                        "type":"boolean"
                    },
                    "variantBasedDisplay":{
                        "description":"Whether this variant based display should be allowed ",
                        "type":"boolean"
                    },
                    "length":{
                        "description":"The length property of the variant",
                        "type":"integer"
                    },
                    "label":{
                        "description":"Label for new item type.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of variant.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether it is required or not.",
                        "type":"boolean"
                    },
                    "writable":{
                        "description":"Whether writable or not.",
                        "type":"string"
                    },
                    "uiEditorType":{
                        "description":"The UIEditorType property of the variant",
                        "type":"string"
                    },
                    "default":{
                        "description":"Default specification of product type.",
                        "type":"string"
                    },
                    "listingVariant":{
                        "description":"Whether listing should be done based on this variant.",
                        "type":"boolean"
                    },
                    "localizable":{
                        "description":"Whether Localizable or not.",
                        "type":"boolean"
                    },
                    "id":{
                        "description":"ID of specification.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Order count of item type.",
                        "type":"integer"
                    }
                }
            }
        },
        "base":{
            "description":"Base type Details",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "itemType":{
                        "description":"Item type for user-defined product.",
                        "type":"string"
                    },
                    "hidden":{
                        "description":"Whether item is hidden.",
                        "type":"boolean"
                    },
                    "variantBasedDisplay":{
                        "description":"Whether this variant based display should be allowed ",
                        "type":"boolean"
                    },
                    "length":{
                        "description":"The length property of the variant",
                        "type":"integer"
                    },
                    "label":{
                        "description":"Label for new item type.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of variant.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether it is required or not.",
                        "type":"boolean"
                    },
                    "writable":{
                        "description":"Whether writable or not.",
                        "type":"string"
                    },
                    "uiEditorType":{
                        "description":"The UIEditorType property of the variant",
                        "type":"string"
                    },
                    "default":{
                        "description":"Default specification of product type.",
                        "type":"string"
                    },
                    "listingVariant":{
                        "description":"Whether listing should be done based on this variant.",
                        "type":"boolean"
                    },
                    "localizable":{
                        "description":"Whether Localizable or not.",
                        "type":"boolean"
                    },
                    "id":{
                        "description":"ID of specification.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Order count of item type.",
                        "type":"integer"
                    }
                }
            }
        }
    }
}

Nested Schema : base

Type: array

Base type Details

Show Source

• Array of: object items

{
    "description":"Base type Details",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "itemType":{
                "description":"Item type for user-defined product.",
                "type":"string"
            },
            "hidden":{
                "description":"Whether item is hidden.",
                "type":"boolean"
            },
            "variantBasedDisplay":{
                "description":"Whether this variant based display should be allowed ",
                "type":"boolean"
            },
            "length":{
                "description":"The length property of the variant",
                "type":"integer"
            },
            "label":{
                "description":"Label for new item type.",
                "type":"string"
            },
            "type":{
                "description":"Data type of variant.",
                "type":"string"
            },
            "required":{
                "description":"Whether it is required or not.",
                "type":"boolean"
            },
            "writable":{
                "description":"Whether writable or not.",
                "type":"string"
            },
            "uiEditorType":{
                "description":"The UIEditorType property of the variant",
                "type":"string"
            },
            "default":{
                "description":"Default specification of product type.",
                "type":"string"
            },
            "listingVariant":{
                "description":"Whether listing should be done based on this variant.",
                "type":"boolean"
            },
            "localizable":{
                "description":"Whether Localizable or not.",
                "type":"boolean"
            },
            "id":{
                "description":"ID of specification.",
                "type":"string"
            },
            "order":{
                "description":"Order count of item type.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : shopperInputs

Type: array

Shopper Inputs corresponding to the productType

Show Source

• Array of: object items

{
    "description":"Shopper Inputs corresponding to the productType",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "uiEditorType":{
                "description":"The UIEditorType property of the shopperInput",
                "type":"string"
            },
            "values":{
                "description":"List of allowed values in case of Single Selection List type.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "name":{
                "description":"The name of the shopperInput",
                "type":"string"
            },
            "label":{
                "description":"The display label of the shopperInput",
                "type":"string"
            },
            "id":{
                "description":"Id corresponding to the shopperInput",
                "type":"string"
            },
            "promptText":{
                "description":"The descriptive text for the shopperInput",
                "type":"string"
            },
            "type":{
                "description":"Data type of shopperInput.",
                "type":"string"
            },
            "required":{
                "description":"Whether it is required or not.",
                "type":"boolean"
            }
        }
    }
}

Nested Schema : specifications

Type: array

List of properties for user-defined item type.

Show Source

• Array of: object items

{
    "description":"List of properties 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"
            },
            "itemType":{
                "description":"Item type for user-defined product.",
                "type":"string"
            },
            "hidden":{
                "description":"Whether item is hidden.",
                "type":"boolean"
            },
            "variantBasedDisplay":{
                "description":"Whether this variant based display should be allowed ",
                "type":"boolean"
            },
            "length":{
                "description":"The length property of the variant",
                "type":"integer"
            },
            "label":{
                "description":"Label for new item type.",
                "type":"string"
            },
            "type":{
                "description":"Data type of variant.",
                "type":"string"
            },
            "required":{
                "description":"Whether it is required or not.",
                "type":"boolean"
            },
            "writable":{
                "description":"Whether writable or not.",
                "type":"string"
            },
            "uiEditorType":{
                "description":"The UIEditorType property of the variant",
                "type":"string"
            },
            "default":{
                "description":"Default specification of product type.",
                "type":"string"
            },
            "listingVariant":{
                "description":"Whether listing should be done based on this variant.",
                "type":"boolean"
            },
            "localizable":{
                "description":"Whether Localizable or not.",
                "type":"boolean"
            },
            "id":{
                "description":"ID of specification.",
                "type":"string"
            },
            "order":{
                "description":"Order count of item type.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : variants

Type: array

Variants of the product

Show Source

• Array of: object items

{
    "description":"Variants of the product",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "itemType":{
                "description":"Item type for user-defined product.",
                "type":"string"
            },
            "hidden":{
                "description":"Whether item is hidden.",
                "type":"boolean"
            },
            "variantBasedDisplay":{
                "description":"Whether this variant based display should be allowed ",
                "type":"boolean"
            },
            "length":{
                "description":"The length property of the variant",
                "type":"integer"
            },
            "label":{
                "description":"Label for new item type.",
                "type":"string"
            },
            "type":{
                "description":"Data type of variant.",
                "type":"string"
            },
            "required":{
                "description":"Whether it is required or not.",
                "type":"boolean"
            },
            "writable":{
                "description":"Whether writable or not.",
                "type":"string"
            },
            "uiEditorType":{
                "description":"The UIEditorType property of the variant",
                "type":"string"
            },
            "default":{
                "description":"Default specification of product type.",
                "type":"string"
            },
            "listingVariant":{
                "description":"Whether listing should be done based on this variant.",
                "type":"boolean"
            },
            "localizable":{
                "description":"Whether Localizable or not.",
                "type":"boolean"
            },
            "id":{
                "description":"ID of specification.",
                "type":"string"
            },
            "order":{
                "description":"Order count of item type.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• default(optional): string
  Default specification of product type.
• hidden(optional): boolean
  Whether item is hidden.
• id(optional): string
  ID of specification.
• itemType(optional): string
  Item type for user-defined product.
• label(optional): string
  Label for new item type.
• length(optional): integer
  The length property of the variant
• listingVariant(optional): boolean
  Whether listing should be done based on this variant.
• localizable(optional): boolean
  Whether Localizable or not.
• order(optional): integer
  Order count of item type.
• required(optional): boolean
  Whether it is required or not.
• type(optional): string
  Data type of variant.
• uiEditorType(optional): string
  The UIEditorType property of the variant
• variantBasedDisplay(optional): boolean
  Whether this variant based display should be allowed
• writable(optional): string
  Whether writable or not.

{
    "type":"object",
    "properties":{
        "itemType":{
            "description":"Item type for user-defined product.",
            "type":"string"
        },
        "hidden":{
            "description":"Whether item is hidden.",
            "type":"boolean"
        },
        "variantBasedDisplay":{
            "description":"Whether this variant based display should be allowed ",
            "type":"boolean"
        },
        "length":{
            "description":"The length property of the variant",
            "type":"integer"
        },
        "label":{
            "description":"Label for new item type.",
            "type":"string"
        },
        "type":{
            "description":"Data type of variant.",
            "type":"string"
        },
        "required":{
            "description":"Whether it is required or not.",
            "type":"boolean"
        },
        "writable":{
            "description":"Whether writable or not.",
            "type":"string"
        },
        "uiEditorType":{
            "description":"The UIEditorType property of the variant",
            "type":"string"
        },
        "default":{
            "description":"Default specification of product type.",
            "type":"string"
        },
        "listingVariant":{
            "description":"Whether listing should be done based on this variant.",
            "type":"boolean"
        },
        "localizable":{
            "description":"Whether Localizable or not.",
            "type":"boolean"
        },
        "id":{
            "description":"ID of specification.",
            "type":"string"
        },
        "order":{
            "description":"Order count of item type.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  Id corresponding to the shopperInput
• label(optional): string
  The display label of the shopperInput
• name(optional): string
  The name of the shopperInput
• promptText(optional): string
  The descriptive text for the shopperInput
• required(optional): boolean
  Whether it is required or not.
• type(optional): string
  Data type of shopperInput.
• uiEditorType(optional): string
  The UIEditorType property of the shopperInput
• values(optional): array values
  List of allowed values in case of Single Selection List type.

{
    "type":"object",
    "properties":{
        "uiEditorType":{
            "description":"The UIEditorType property of the shopperInput",
            "type":"string"
        },
        "values":{
            "description":"List of allowed values in case of Single Selection List type.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "name":{
            "description":"The name of the shopperInput",
            "type":"string"
        },
        "label":{
            "description":"The display label of the shopperInput",
            "type":"string"
        },
        "id":{
            "description":"Id corresponding to the shopperInput",
            "type":"string"
        },
        "promptText":{
            "description":"The descriptive text for the shopperInput",
            "type":"string"
        },
        "type":{
            "description":"Data type of shopperInput.",
            "type":"string"
        },
        "required":{
            "description":"Whether it is required or not.",
            "type":"boolean"
        }
    }
}

Nested Schema : values

Type: array

List of allowed values in case of Single Selection List type.

Show Source

• Array of: string

{
    "description":"List of allowed values in case of Single Selection List type.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• default(optional): string
  Default specification of product type.
• hidden(optional): boolean
  Whether item is hidden.
• id(optional): string
  ID of specification.
• itemType(optional): string
  Item type for user-defined product.
• label(optional): string
  Label for new item type.
• length(optional): integer
  The length property of the variant
• listingVariant(optional): boolean
  Whether listing should be done based on this variant.
• localizable(optional): boolean
  Whether Localizable or not.
• order(optional): integer
  Order count of item type.
• required(optional): boolean
  Whether it is required or not.
• type(optional): string
  Data type of variant.
• uiEditorType(optional): string
  The UIEditorType property of the variant
• validationPattern(optional): string
  Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.
• variantBasedDisplay(optional): boolean
  Whether this variant based display should be allowed
• writable(optional): string
  Whether writable or not.

{
    "type":"object",
    "properties":{
        "validationPattern":{
            "description":"Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.",
            "type":"string"
        },
        "itemType":{
            "description":"Item type for user-defined product.",
            "type":"string"
        },
        "hidden":{
            "description":"Whether item is hidden.",
            "type":"boolean"
        },
        "variantBasedDisplay":{
            "description":"Whether this variant based display should be allowed ",
            "type":"boolean"
        },
        "length":{
            "description":"The length property of the variant",
            "type":"integer"
        },
        "label":{
            "description":"Label for new item type.",
            "type":"string"
        },
        "type":{
            "description":"Data type of variant.",
            "type":"string"
        },
        "required":{
            "description":"Whether it is required or not.",
            "type":"boolean"
        },
        "writable":{
            "description":"Whether writable or not.",
            "type":"string"
        },
        "uiEditorType":{
            "description":"The UIEditorType property of the variant",
            "type":"string"
        },
        "default":{
            "description":"Default specification of product type.",
            "type":"string"
        },
        "listingVariant":{
            "description":"Whether listing should be done based on this variant.",
            "type":"boolean"
        },
        "localizable":{
            "description":"Whether Localizable or not.",
            "type":"boolean"
        },
        "id":{
            "description":"ID of specification.",
            "type":"string"
        },
        "order":{
            "description":"Order count of item type.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• default(optional): string
  Default specification of product type.
• hidden(optional): boolean
  Whether item is hidden.
• id(optional): string
  ID of specification.
• itemType(optional): string
  Item type for user-defined product.
• label(optional): string
  Label for new item type.
• length(optional): integer
  The length property of the variant
• listingVariant(optional): boolean
  Whether listing should be done based on this variant.
• localizable(optional): boolean
  Whether Localizable or not.
• order(optional): integer
  Order count of item type.
• required(optional): boolean
  Whether it is required or not.
• type(optional): string
  Data type of variant.
• uiEditorType(optional): string
  The UIEditorType property of the variant
• variantBasedDisplay(optional): boolean
  Whether this variant based display should be allowed
• writable(optional): string
  Whether writable or not.

{
    "type":"object",
    "properties":{
        "itemType":{
            "description":"Item type for user-defined product.",
            "type":"string"
        },
        "hidden":{
            "description":"Whether item is hidden.",
            "type":"boolean"
        },
        "variantBasedDisplay":{
            "description":"Whether this variant based display should be allowed ",
            "type":"boolean"
        },
        "length":{
            "description":"The length property of the variant",
            "type":"integer"
        },
        "label":{
            "description":"Label for new item type.",
            "type":"string"
        },
        "type":{
            "description":"Data type of variant.",
            "type":"string"
        },
        "required":{
            "description":"Whether it is required or not.",
            "type":"boolean"
        },
        "writable":{
            "description":"Whether writable or not.",
            "type":"string"
        },
        "uiEditorType":{
            "description":"The UIEditorType property of the variant",
            "type":"string"
        },
        "default":{
            "description":"Default specification of product type.",
            "type":"string"
        },
        "listingVariant":{
            "description":"Whether listing should be done based on this variant.",
            "type":"boolean"
        },
        "localizable":{
            "description":"Whether Localizable or not.",
            "type":"boolean"
        },
        "id":{
            "description":"ID of specification.",
            "type":"string"
        },
        "order":{
            "description":"Order count of item type.",
            "type":"integer"
        }
    }
}

Back to Top