GET v1/ShopGroup/{shopGroupId}/Products/{productCode}
Get detailed information about a product, based on the unique ProductCode (SKU).
Request Information
Requires Authorization!
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| shopGroupId |
The ShopGroup |
integer |
Required. |
| productCode |
The unique ProductCode |
string |
Required. |
Body Parameters
None.
Response Information
Resource Description
Product
| Name | Description | Type | Additional information |
|---|---|---|---|
| ShopGroupId |
Gets or sets the shop group identifier. |
integer |
Required |
| EAN |
Gets or sets the European Article Number. |
string |
None. |
| Note |
Gets or sets the note. |
string |
Max length: 2147483647 |
| CustomerMustAskForPrice |
Gets or sets a value indicating whether the customer should not see the price, but must explicitly ask for it. |
boolean |
Required |
| ProductVariantParentId |
Gets or sets the creation date. The Id to the ProductVariant parent. The Type of the product should be ProductVariant (2) when used. |
integer |
None. |
| VariantInfo |
This field contains a summary of the values of the Variation properties. This field is only used when the Type = ProductVariant (2). Eg: 'Black | XL' |
string |
Max length: 100 |
| CreationDate |
Gets the creation date. |
date |
Required |
| ChangedTimestamp |
Gets the changed timestamp. |
date |
None. |
| MainImageFileId |
Gets or sets the main image file identifier. |
integer |
None. |
| KeepStock |
Gets or sets a value indicating whether [keep stock]. |
boolean |
Required |
| MinimumStock |
Gets or sets the minimum stock. |
decimal number |
Required |
| QtyAvailable |
Gets or sets the qty available. |
decimal number |
Required |
| QtyOnHand |
Gets or sets the qty on hand. |
decimal number |
Required |
| QtyReserved |
Gets or sets the qty reserved. |
decimal number |
Required |
| SyncEnabled |
Gets or sets a value indicating whether [synchronize enabled]. |
boolean |
Required |
| Published |
Gets or sets a value indicating whether this is published. |
boolean |
Required |
| Weight |
Gets or sets the weight. |
decimal number |
None. |
| WeightUOMId |
Gets or sets the weight uom identifier. |
integer |
None. |
| Height |
Gets or sets the height. |
decimal number |
None. |
| HeightUOMId |
Gets or sets the height uom identifier. |
integer |
None. |
| Length |
Gets or sets the length. |
decimal number |
None. |
| LengthUOMId |
Gets or sets the length uom identifier. |
integer |
None. |
| Width |
Gets or sets the width. |
decimal number |
None. |
| WidthUOMId |
Gets or sets the width uom identifier. |
integer |
None. |
| PriceExVat |
Gets or sets the price ex vat. |
decimal number |
Required |
| ProductPropertyDefSetId |
Gets or sets the product property definition set identifier. |
integer |
None. |
| ProductGroups |
Gets or sets the product groups. |
Collection of integer |
None. |
| Images |
Gets or sets the images. |
Collection of integer |
None. |
| Properties |
A collection of translatable Product Properties. Following property codes are system properties which can be used: "Name", "Description", "Published", "DescriptionLong", "MetaTitle", "MetaKeywords", "MetaDescription", "NameTemplate", "DescriptionTemplate", "DescriptionLongTemplate" |
Collection of ProductProperty |
None. |
| ProductVariantPropertyDefIds |
This collection holds the Id's of ProductPropertyDefinitions which are used to create Product Variants for. This collection is only used when the Product is of the Type ProductVariantParent. |
Collection of integer |
None. |
| ProductVariantIds |
This collection holds the Id's of the (child) Product Variants. This collection is only used when the Product is of the Type ProductVariantParent. |
Collection of integer |
None. |
| Id |
Gets or sets the identifier. |
integer |
Required |
| Code |
Gets or sets the code. |
string |
Required Max length: 50 |
| Name |
Gets or sets the name. |
string |
Max length: 400 |
| Type |
The ProductType, available: SimpleProduct = 0, ProductVariantParent = 1, ProductVariant = 2 |
integer |
None. |
Response Formats
application/json, text/json
{
"ShopGroupId": 1,
"EAN": "sample string 2",
"Note": "sample string 3",
"CustomerMustAskForPrice": true,
"ProductVariantParentId": 1,
"VariantInfo": "sample string 5",
"CreationDate": "2026-04-03T18:31:01.1784393+02:00",
"ChangedTimestamp": "2026-04-03T18:31:01.1784393+02:00",
"MainImageFileId": 1,
"KeepStock": true,
"MinimumStock": 8.0,
"QtyAvailable": 9.0,
"QtyOnHand": 10.0,
"QtyReserved": 11.0,
"SyncEnabled": true,
"Published": true,
"Weight": 1.0,
"WeightUOMId": 1,
"Height": 1.0,
"HeightUOMId": 1,
"Length": 1.0,
"LengthUOMId": 1,
"Width": 1.0,
"WidthUOMId": 1,
"PriceExVat": 14.0,
"ProductPropertyDefSetId": 1,
"ProductGroups": [
1,
2
],
"Images": [
1,
2
],
"Properties": [
{
"CultureId": 1,
"ShopId": 1,
"ProductPropertyDefId": 1,
"Code": "sample string 2",
"Value": "sample string 3"
},
{
"CultureId": 1,
"ShopId": 1,
"ProductPropertyDefId": 1,
"Code": "sample string 2",
"Value": "sample string 3"
}
],
"ProductVariantPropertyDefIds": [
1,
2
],
"ProductVariantIds": [
1,
2
],
"Id": 15,
"Code": "sample string 16",
"Name": "sample string 17",
"Type": 18
}
application/xml, text/xml
<Product xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Id>15</Id>
<Code>sample string 16</Code>
<Name>sample string 17</Name>
<Type>18</Type>
<ShopGroupId>1</ShopGroupId>
<EAN>sample string 2</EAN>
<Note>sample string 3</Note>
<CustomerMustAskForPrice>true</CustomerMustAskForPrice>
<ProductVariantParentId>1</ProductVariantParentId>
<VariantInfo>sample string 5</VariantInfo>
<CreationDate>2026-04-03T18:31:01.1784393+02:00</CreationDate>
<ChangedTimestamp>2026-04-03T18:31:01.1784393+02:00</ChangedTimestamp>
<MainImageFileId>1</MainImageFileId>
<KeepStock>true</KeepStock>
<MinimumStock>8</MinimumStock>
<QtyAvailable>9</QtyAvailable>
<QtyOnHand>10</QtyOnHand>
<QtyReserved>11</QtyReserved>
<SyncEnabled>true</SyncEnabled>
<Published>true</Published>
<Weight>1</Weight>
<WeightUOMId>1</WeightUOMId>
<Height>1</Height>
<HeightUOMId>1</HeightUOMId>
<Length>1</Length>
<LengthUOMId>1</LengthUOMId>
<Width>1</Width>
<WidthUOMId>1</WidthUOMId>
<PriceExVat>14</PriceExVat>
<ProductPropertyDefSetId>1</ProductPropertyDefSetId>
<ProductGroups>
<ProductGroupId>1</ProductGroupId>
<ProductGroupId>2</ProductGroupId>
</ProductGroups>
<Images>
<ImageFileId>1</ImageFileId>
<ImageFileId>2</ImageFileId>
</Images>
<Properties>
<Property>
<CultureId>1</CultureId>
<ShopId>1</ShopId>
<ProductPropertyDefId>1</ProductPropertyDefId>
<Code>sample string 2</Code>
<Value>sample string 3</Value>
</Property>
<Property>
<CultureId>1</CultureId>
<ShopId>1</ShopId>
<ProductPropertyDefId>1</ProductPropertyDefId>
<Code>sample string 2</Code>
<Value>sample string 3</Value>
</Property>
</Properties>
<ProductVariantPropertyDefIds>
<ProductVariantPropertyDefIds>1</ProductVariantPropertyDefIds>
<ProductVariantPropertyDefIds>2</ProductVariantPropertyDefIds>
</ProductVariantPropertyDefIds>
<ProductVariantIds>
<ProductVariantIds>1</ProductVariantIds>
<ProductVariantIds>2</ProductVariantIds>
</ProductVariantIds>
</Product>