Update Product Type

put https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}

Update product type.

Path Params

productTypeId

int32

required

Query Params

responseFields

string

limits which fields are returned in the response body

Body Params

int32 | null

Unique identifier of the ProductType. System-supplied and read-only.

name

string | null

Name of the productType

masterCatalogId

int32 | null

Indentifier of the Master Catalog that this ProductType is a member of. System-supplied and read-only.

isBaseProductType

boolean

System supplied and read only. There is only one BaseProductType per MasterCatalog.

productCount

int32 | null

Indicates the number of products currently using this Product Type. System-supplied and read-only.

productUsages

array of strings | null

List of ProductUsages supported by the ProductType.

productUsages

goodsType

string | null

The TYpe of Goods of this product

options

array of objects | null

Collection of the Attributes that are Options in this productType

options

extras

array of objects | null

Collection of the Attributes that are Extras in this productType

extras

properties

array of objects | null

Collection of the Attributes that are Properties in this productType

properties

variantProperties

array of objects | null

Collection of the Attributes that are VariantProperties in this productType

variantProperties

auditInfo

object

Response

Response body

object

int32 | null

Unique identifier of the ProductType. System-supplied and read-only.

name

string | null

Name of the productType

masterCatalogId

int32 | null

Indentifier of the Master Catalog that this ProductType is a member of. System-supplied and read-only.

isBaseProductType

boolean

System supplied and read only. There is only one BaseProductType per MasterCatalog.

productCount

int32 | null

Indicates the number of products currently using this Product Type. System-supplied and read-only.

productUsages

array of strings | null

List of ProductUsages supported by the ProductType.

productUsages

goodsType

string | null

The TYpe of Goods of this product

options

array of objects | null

Collection of the Attributes that are Options in this productType

options

object

attributeFQN

string | null

Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed

isInheritedFromBaseType

boolean | null

If True, the attribute is part of the base product type and can only have order modified.

order

int32 | null

Used to order the display of the attributes within a section

isRequiredByAdmin

boolean | null

If True, the admin must include this attribute in products of this productType

isHiddenProperty

boolean | null

If True, the property is hidden in the storefront. This field only applies to properties.

isAdminOnlyProperty

boolean | null

If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API.

isProductDetailsOnlyProperty

boolean | null

If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)

isMultiValueProperty

boolean | null

If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.

displayInfo

object

vocabularyValues

array of objects | null

The collection of vocabulary values included in this product type.

vocabularyValues

object

value

string

The actual value of the attribute vocabulary. This must be an existing value defined in the attribute vocabulary

order

int32 | null

Used to order the display of the attribute values in the storefront....

displayInfo

object

vocabularyValueDetail

object

Value of an attribute

attributeDetail

object

Attribute

extras

array of objects | null

Collection of the Attributes that are Extras in this productType

extras

object

attributeFQN

string | null

Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed

isInheritedFromBaseType

boolean | null

If True, the attribute is part of the base product type and can only have order modified.

order

int32 | null

Used to order the display of the attributes within a section

isRequiredByAdmin

boolean | null

If True, the admin must include this attribute in products of this productType

isHiddenProperty

boolean | null

If True, the property is hidden in the storefront. This field only applies to properties.

isAdminOnlyProperty

boolean | null

isProductDetailsOnlyProperty

boolean | null

If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)

isMultiValueProperty

boolean | null

If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.

displayInfo

object

vocabularyValues

array of objects | null

The collection of vocabulary values included in this product type.

vocabularyValues

object

value

string

The actual value of the attribute vocabulary. This must be an existing value defined in the attribute vocabulary

order

int32 | null

Used to order the display of the attribute values in the storefront....

displayInfo

object

vocabularyValueDetail

object

Value of an attribute

attributeDetail

object

Attribute

properties

array of objects | null

Collection of the Attributes that are Properties in this productType

properties

object

attributeFQN

string | null

Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed

isInheritedFromBaseType

boolean | null

If True, the attribute is part of the base product type and can only have order modified.

order

int32 | null

Used to order the display of the attributes within a section

isRequiredByAdmin

boolean | null

If True, the admin must include this attribute in products of this productType

isHiddenProperty

boolean | null

If True, the property is hidden in the storefront. This field only applies to properties.

isAdminOnlyProperty

boolean | null

isProductDetailsOnlyProperty

boolean | null

If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)

isMultiValueProperty

boolean | null

If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.

displayInfo

object

vocabularyValues

array of objects | null

The collection of vocabulary values included in this product type.

vocabularyValues

object

value

string

The actual value of the attribute vocabulary. This must be an existing value defined in the attribute vocabulary

order

int32 | null

Used to order the display of the attribute values in the storefront....

displayInfo

object

vocabularyValueDetail

object

Value of an attribute

attributeDetail

object

Attribute

variantProperties

array of objects | null

Collection of the Attributes that are VariantProperties in this productType

variantProperties

object

attributeFQN

string | null

Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed

isInheritedFromBaseType

boolean | null

If True, the attribute is part of the base product type and can only have order modified.

order

int32 | null

Used to order the display of the attributes within a section

isRequiredByAdmin

boolean | null

If True, the admin must include this attribute in products of this productType

isHiddenProperty

boolean | null

If True, the property is hidden in the storefront. This field only applies to properties.

isAdminOnlyProperty

boolean | null

isProductDetailsOnlyProperty

boolean | null

If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)

isMultiValueProperty

boolean | null

If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.

displayInfo

object

vocabularyValues

array of objects | null

The collection of vocabulary values included in this product type.

vocabularyValues

object

value

string

The actual value of the attribute vocabulary. This must be an existing value defined in the attribute vocabulary

order

int32 | null

Used to order the display of the attribute values in the storefront....

displayInfo

object

vocabularyValueDetail

object

Value of an attribute

attributeDetail

object

Attribute

auditInfo

object

updateDate

date-time | null

createDate

date-time | null

updateBy

string | null

createBy

string | null

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://t0-s0.sandbox.mozu.com/api/commerce/catalog/admin/attributedefinition/producttypes/productTypeId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success