Products/Styles

put/api/styles/{id}

Path parameters

idstring required

Request body

namestring required

Display name of the product.

forCompanyIdstring

Retraced ID of the brand or company that owns this product.

descriptionstring nullable

Free-text product description. Nullable.

genderstring nullable

Product gender classification. Known values: MALE, FEMALE, UNISEX. Nullable.

brandsstring[] nullable

User-defined brand labels associated with this product. Free-text strings set by the brand — no fixed taxonomy or lookup endpoint. Use to identify which sub-brand a product is sold under (e.g. 'Columbia', 'Prana').

departmentsstring[] nullable

User-defined department labels. Free-text strings set by the user — no fixed taxonomy or lookup endpoint.

seasonsstring[] nullable

User-defined season labels. Free-text strings set by the user — no fixed taxonomy or lookup endpoint.

collectionsstring[] nullable

User-defined collection labels. Free-text strings set by the user — no fixed taxonomy or lookup endpoint.

claimIntentionsstring[] nullable
customPropertiesstring nullable
suppliersstring[] nullable

Array of supplier IDs that can fulfil this product, including the main supplier and any alternates. Use the companyId values here to query GET /supply-chains/:styleId for detailed supply chain data.

mainSupplierstring nullable

The single designated primary supplier for this product. Null if not set. A product can have many entries in suppliers but at most one mainSupplier.

vendorsstring[] nullable
imagesFileIdsstring[] nullable
isStoryActiveboolean
externalIdstring nullable

Your own identifier for this product. Unique per company across all product levels. Can be used in place of the Retraced ID on any product ID field in this API. On update it is only written when the field is present in the body — omitting it keeps the stored value, sending null clears it.

styleTypeIdstring
styleLevelIdstring

Response

Default Response

Changes