Skip to content

Product update

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

Product GUID. Must be unique if set.

typestring

Product type. Please note that 'product-set' requires 'sets' module to be enabled. Enum - see Product types code list.

Enum:"product""bazar""service""product-set"
visibilitystring

Product visibility. Optional, default value visible. Enum - see Product visibility code list.

Enum:"hidden""visible""blocked""show-registered""block-unregistered""cash-desk-only""detail-only"
namestring, [ 1 .. 250 ] characters

Product's name. Mandatory. Maximal length of 250 characters.

adultboolean or null

Whether the product is for adults only. Optional, default value false.

shortDescriptionstring or null

Product's short description.

descriptionstring or null

Product's full description.

additionalNamestring or null, <= 150 characters

Product's additional name. Optional. Maximal length of 150 characters.

metaTitlestring or null, [ 1 .. 255 ] characters

Product's seo title. Maximal length of 255 characters.

metaDescriptionstring or null

Product's full description.

conditionGradestring or null, non-empty

Grade condition of second-hand product. Allowed only for bazar type.

conditionDescriptionstring or null, non-empty

Condition description of second-hand product. Allowed only for bazar type.

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

Product's default category's GUID. Mandatory.

brandCodestring or null, non-empty

Product's brand indexName/code. Must exist if set.

internalNotestring or null, non-empty

Product internal note.

preauthorizationRequiredboolean

whether the preauthorization is required; available only if shoptet pay module is enabled

hsCodestring or null(typeHsCodeNullable)^\d{6,10}$

Harmonized system code with 6–10 digits (accepting leading zeros).

supplierGuidstring or null, [ 1 .. 36 ] characters(typeGuidNullable)^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Supplier GUID. Must exist if set.

categoryGuidsArray of strings, non-empty
warrantyIdinteger or null

Warranty ID.

flagsArray of objects or null

Must exist if set. Cannot be set together with the param flagsManagement.

flagsManagementArray of objects or null, non-empty

Alternative way to manage the flags by specific actions. Cannot be set together with the param flags.

descriptiveParametersArray of objects

Product descriptive parameters.

filteringParametersArray of objects or null
surchargeParametersArray of objects(productRequestSurchargeParameter)

Product surcharge parameters. Not allowed for products with multiple tax classes.

variantsArray of objects, non-empty
indexNamestring, non-empty

String which defines product url. Value is sanitized to fits url needs = All characters except [a-zA-Z0-9_] will be converted to -. If value is not present, indexName is created from product name.

relatedVideosArray of objects

Product related videos.

languagestring

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

{
  "language": "cs",
  "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "type": "product",
  "visibility": "hidden",
  "name": "Velká čokoláda",
  "adult": true,
  "shortDescription": "Velice kvalitní a dobrá čokoláda.",
  "description": "<p>Velice kvalitní a dobrá čokoláda. Chutná vždy dobře. <b>Neobsahuje arašídy.</b></p>",
  "additionalName": "Velice kvalitní a dobrá čokoláda.",
  "metaTitle": "Velice kvalitní a dobrá čokoláda.",
  "metaDescription": "Velice kvalitní a dobrá čokoláda. Chutná vždy dobře. Neobsahuje arašídy.",
  "conditionGrade": "used",
  "conditionDescription": "Without original package.",
  "defaultCategoryGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "brandCode": "milka",
  "internalNote": "Internal note for product manager.",
  "preauthorizationRequired": true,
  "hsCode": "95030099",
  "supplierGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "categoryGuids": [
    "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"
  ],
  "warrantyId": 1,
  "flags": [
    { … }
  ],
  "flagsManagement": [
    { … }
  ],
  "descriptiveParameters": [
    { … }
  ],
  "filteringParameters": [
    { … }
  ],
  "surchargeParameters": [
    { … }
  ],
  "variants": [
    { … }
  ],
  "indexName": "baleriny-modre-s-puntiky",
  "relatedVideos": [
    { … }
  ]
}