Skip to content

Category update

non-empty
guidstring, <= 36 characters(typeGuid)^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Category GUID. Must be unique if set. Optional.

namestring, [ 1 .. 255 ] characters

Category name. Optional.

parentGuidstring or null, <= 36 characters(typeGuidNullable)^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Parent category GUID. Category must exist if set. Optional.

descriptionstring or null

Category description. Max length 65535 bytes. Optional.

secondDescriptionstring or null

Bottom category description. Max length 65535 bytes. Optional.

sourceImageNamestring or null, <= 255 characters(typeFilenameNullable)^[0-9a-zA-Z_\-.]+$

Name of file in Files upload storage to be set as category image.

sortBeforestring, <= 36 characters(typeGuid)^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Guid of category before which you want to move the category from the request. Not possible to use with sortAfter. Optional.

sortAfterstring, <= 36 characters(typeGuid)^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Guid of category after which you want to move the category from the request. Not possible to use with sortBefore. Optional.

indexNamestring, non-empty

Last part of url. Optional, generated from name if not set.

menuTitlestring or null, [ 1 .. 255 ] characters

Label for menu. Optional.

titlestring or null, [ 1 .. 255 ] characters

Meta tag title. Optional.

metaTagDescriptionstring or null

Meta tag description. Optional.

visibleboolean

Whether the category is visible. Optional, default true.

customerVisibilitystring

defines users of the e-shop who can see the category - all = all (default), registered = registered users, unregistered = non-registered users. Optional.

Enum:"all""registered""unregistered""admin-only"
productOrderingstring

defines how products are sorted in a category; see also Sorting of products in category code list

Enum:"default""most-selling""cheapest""most-expensive""oldest""newest""alphabetically""alphabetically-desc""product-code""product-code-desc"
similarProductsCategorystring or null, <= 36 characters(typeGuidNullable)^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Similar category guid. Optional.

relatedProductsCategorystring or null, <= 36 characters(typeGuidNullable)^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Related category guid. Optional.

languagestring

language of entity (available only if module foreignLanguages is active and initialized)

imageNamestring or nulldeprecated

Category image. File must exist on the server. Optional. (Use sourceImageName instead)

{
  "language": "cs",
  "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "name": "Watches",
  "parentGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "description": "<p>Top category description</p>",
  "secondDescription": "<p>Bottom category description</p>",
  "imageName": "watches-category-image.jpg",
  "sourceImageName": "image.png",
  "sortBefore": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "sortAfter": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "indexName": "watches",
  "menuTitle": "Watches",
  "title": "Watches",
  "metaTagDescription": "Watches, Apple watch, black, white, garmin",
  "visible": true,
  "customerVisibility": "all",
  "productOrdering": "alphabetically",
  "similarProductsCategory": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "relatedProductsCategory": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"
}