Skip to content

Product detail by code

Request

Retrieve details about one product. Optional sections can be requested using ?include= parameter The response format is the same as for Product detail endpoint.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
codestringrequired

product or variant code.

Example:133
Query
includestring

Optional parts of response

Example:include=images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,c
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/products/code/133?include=images%2CvariantParameters%2CallCategories%2Cflags%2CdescriptiveParameters%2CmeasureUnit%2CsurchargeParameters%2CsetItems%2CfilteringParameters%2CrecyclingFee%2CconsumptionTax%2CperStockAmounts%2CsortVariants%2CperPricelistPrices' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobject(product)
errorsArray of objects or null(Errors)
metadataobject(Metadata)
Response
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "type": "product",
    "name": "Pelle 1978",
    "indexName": "baleriny-modre-s-puntiky",
    "brand": { … },
    "supplier": { … },
    "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": { … },
    "categories": [ … ],
    "descriptiveParameters": [ … ],
    "additionalName": "+ free gift",
    "xmlFeedName": "our-feed.xml",
    "metaTitle": "Nice product title",
    "adult": true,
    "atypicalBilling": true,
    "atypicalShipping": true,
    "allowIPlatba": true,
    "allowOnlinePayments": true,
    "sizeIdName": "adidas - man - shoes (ID 142)",
    "voteAverageScore": "1.000",
    "voteCount": 16,
    "isVariant": true,
    "variants": [ … ],
    "images": [ … ],
    "flags": [ … ],
    "surchargeParameters": [ … ],
    "setItems": [ … ],
    "filteringParameters": [ … ],
    "warranty": { … },
    "gifts": [ … ],
    "alternativeProducts": [ … ],
    "relatedProducts": [ … ],
    "relatedFiles": [ … ],
    "relatedVideos": [ … ]
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}