Skip to content

Product

guidstring, <= 36 characters(typeGuidUnlimited)required

unique product indicator

Example:"1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"
typestringrequired

product type (product, bazar...) - see also Product types code list

Example:"product"
namestring or null

product name

Example:"Pelle 1978"
indexNamestring

String which defines product url.

Example:"baleriny-modre-s-puntiky"
brandbrandNamed (object) or nullrequired
One of:

product brand (or manufacturer, possibly)

suppliersupplier (object) or nullrequired
One of:

product supplier

visibilitystringrequired

visibility of product (normal, hidden ...) - see also Product visibility code list

Example:"normal"
creationTimestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of product creation (date in ISO 8601 format)

Example:"2018-05-29T09:02:27+0200"
changeTimestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time of last product change (date in ISO 8601 format)

Example:"2018-05-29T09:02:27+0200"
shortDescriptionstring or nullrequired

short product description

Example:"A high quality jacket, although its fairly bold design is not to everyone's taste, it has its fans, so you can find it in our offer too. For kids, wh
descriptionstring or nullrequired

product description. May contain html.

Example:"<p>As it is often the case with jackets for kids, the emphasis is primarily on durability and quality workmanship. It is clear that it will be put th
metaDescriptionstring or nullrequired

product label from meta tag.

Example:"Pelle 1978. A high quality jacket, although its fairly bold design is not to everyone's taste .... "
urlstring or nullrequired

URL of the product in the e-shop

Example:"https://www.domena-eshopu.cz/hodinky/citizen-chronograph-eco-drive/"
conditionGradestring or null

Grade condition of second-hand product. It contains value only for bazar type, otherwise, it is null.

Example:"used"
conditionDescriptionstring or null

Condition description of second-hand product. It contains value only for bazar type, otherwise, it is null.

Example:"Without original package"
internalNotestring or nullrequired

product internal note

Example:"This product is not in stock, but it is possible to order it."
preauthorizationRequiredboolean

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

Example:true
hsCodestring or null(typeHsCodeNullable)^\d{6,10}$required

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

Example:"95030099"
defaultCategoryobjectrequired

default product category

categoriesArray of objects

information about available product categories

descriptiveParametersArray of objects

product description parameters

additionalNamestring or null

Additional part of product name

Example:"+ free gift"
xmlFeedNamestring or null

Name to be sent to product search engine feeds instead of the product's name shown on the e-shop. If the product has variants, the variant name is appended.

Example:"Velká čokoláda Twist"
metaTitlestring

Meta (seo) title

Example:"Nice product title"
adultboolean

Flag, whether the product is for adults only

Example:true
allowIPlatbaboolean

Is Cofidis payment allowed?

Example:true
allowOnlinePaymentsboolean

Are online Payments allowed?

Example:true
sizeIdNamestring or null

Name for sizeid.com

Example:"adidas - man - shoes (ID 142)"
voteAverageScorestring or null(typeAmountNullable)^(-)?[0-9]+\.[0-9]{3}$

Average score of product reviews

Example:2.6
voteCountinteger or null

Count of product reviews

Example:16
isVariantboolean

define if product has multiple variants.

Example:true
variantsArray of objectsrequired

information about available product variants. For a product without variants, this field contains just one element with product details.

imagesArray of objects

information about images.

flagsArray of objects

product flags

surchargeParametersArray of objects(productSurchargeParameter)

product surcharge parameters

setItemsArray of objects or null

information about items, products, in set

filteringParametersArray of objects

product filtering parameters

warrantyobject or null

product warranty

giftsArray of objects(productGifts)

Gifts related to product

alternativeProductsArray of objects or null(relatedProduct)
relatedProductsArray of objects or null(relatedProduct)
relatedFilesArray of objects

files related to product

relatedVideosArray of objects

Videos related to product

atypicalBillingbooleandeprecated

(Moved to variant) - Has atypical billing?

atypicalShippingbooleandeprecated

(Moved to variant) - Has atypical shipping?

Example:true
{
  "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "type": "product",
  "name": "Pelle 1978",
  "indexName": "baleriny-modre-s-puntiky",
  "brand": {
    "code": "willy-wonka",
    "name": "Willy Wonka"
  },
  "supplier": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "name": "Willy Wonka"
  },
  "visibility": "normal",
  "creationTime": "2018-05-29T09:02:27+0200",
  "changeTime": "2018-05-29T09:02:27+0200",
  "shortDescription": "A high quality jacket, although its fairly bold design is not to everyone's taste, it has its fans, so you can find it in our offer too. For kids, why not.",
  "description": "<p>As it is often the case with jackets for kids, the emphasis is primarily on durability and quality workmanship. It is clear that it will be put through its paces, which the manufacturer has borne in mind. As previously stated, the manufacturer could also afford a less conservative design for a kids product, combining bold colors with a company logo on the front and back.</p>\n\n<ul>\n\t<li>Body - 60% Nylon, 40% wool</li>\n<li>Inside - 100% Polyester</li>\n</ul>",
  "metaDescription": "Pelle 1978. A high quality jacket, although its fairly bold design is not to everyone's taste .... ",
  "url": "https://www.domena-eshopu.cz/hodinky/citizen-chronograph-eco-drive/",
  "conditionGrade": "used",
  "conditionDescription": "Without original package",
  "internalNote": "This product is not in stock, but it is possible to order it.",
  "preauthorizationRequired": true,
  "hsCode": "95030099",
  "defaultCategory": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "name": "Watches",
    "visible": true
  },
  "categories": [
    { … }
  ],
  "descriptiveParameters": [
    { … }
  ],
  "additionalName": "+ free gift",
  "xmlFeedName": "Velká čokoláda Twist",
  "metaTitle": "Nice product title",
  "adult": true,
  "atypicalBilling": true,
  "atypicalShipping": true,
  "allowIPlatba": true,
  "allowOnlinePayments": true,
  "sizeIdName": "adidas - man - shoes (ID 142)",
  "voteAverageScore": 2.6,
  "voteCount": 16,
  "isVariant": true,
  "variants": [
    { … }
  ],
  "images": [
    { … }
  ],
  "flags": [
    { … }
  ],
  "surchargeParameters": [
    { … }
  ],
  "setItems": [
    { … }
  ],
  "filteringParameters": [
    { … }
  ],
  "warranty": {
    "id": -1,
    "inMonths": 24,
    "description": "2 years"
  },
  "gifts": [
    { … }
  ],
  "alternativeProducts": [
    { … }
  ],
  "relatedProducts": [
    { … }
  ],
  "relatedFiles": [
    { … }
  ],
  "relatedVideos": [
    { … }
  ]
}