Products/Styles
put/api/styles/{id}

Request

  • Base URL
    https://api.retraced.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.retraced.com/api/styles/{id}
  • Auth
    none declared

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

Array of style property IDs of category 'customProperties'. Values must be created via POST /style-properties before use.

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

    • breaking

      the request property type changed from string to array

    • breaking

      response property data/customProperties list-of-types was widened by adding types array and null to media type application/json of response 200

    • breaking

      added the new required request property /

    • breaking

      added the new required request property /

    • breaking

      removed subschema #1 subschema #2 from the request property anyOf list

    • breaking

      removed subschema #1 subschema #2 from the request property anyOf list

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property type changed from no type to object

    • breaking

      the request property type changed from no type to object

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • warning

      the request property's maxLength was set to 4000

    • warning

      the request property's maxLength was set to 255

    • warning

      the request property's maxLength was set to 50

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      response property data/customProperties list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/ecoFootPrint/anyOf[subschema #1]/recyclabilityAbsenceDisruptor list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/ecoFootPrint/anyOf[subschema #1]/recyclabilityCanBeSorted list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/ecoFootPrint/anyOf[subschema #1]/recyclabilityCanCollectAtScale list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/ecoFootPrint/anyOf[subschema #1]/recyclabilityIndustrialScale list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/ecoFootPrint/anyOf[subschema #1]/recyclabilityRate list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/externalId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/contentType list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/createdBy list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/createdByApiKeyId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/createdByApiKeyLabel list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/createdByCompanyId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/createdByImpersonateId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/createdByImpersonateName list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/createdByUserId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/fileHash list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/fileSize list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/fileType list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/updatedByApiKeyId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/updatedByApiKeyLabel list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/updatedByCompanyId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/updatedByCompanyName list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/updatedByImpersonateId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/updatedByImpersonateName list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/updatedByUserId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/images/items/updatedByUserName list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/isComponent list-of-types was narrowed by removing types number from media type application/json of response 200

    • info

      response property data/isStoryActive list-of-types was narrowed by removing types number from media type application/json of response 200

    • info

      response property data/productLevel list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/qrCodeUrl list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/tracingStory/anyOf[subschema #1]/tracingName list-of-types was narrowed by removing types null from media type application/json of response 200