GET v1/ProductGroups/{productGroupId}
Get detailed information about a Product group.
Request Information
Requires Authorization!
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
productGroupId |
The id of the Product group. |
integer |
Required. |
Body Parameters
None.
Response Information
Resource Description
The ProductGroup object.
ProductGroup
Name | Description | Type | Additional information |
---|---|---|---|
ChangedTimestamp |
Gets or sets the changed timestamp. |
date |
None. |
ShopGroupId |
Gets or sets the shop group identifier. |
integer |
Required |
Sequence |
Gets or sets the sequence. |
integer |
Required |
Comment |
Gets or sets the comment. |
string |
Max length: 2147483647 |
SyncEnabled |
Gets or sets a value indicating whether the synchronize is enabled. |
boolean |
Required |
IsActive |
Gets or sets a value indicating whether this instance is active. |
boolean |
Required |
IncludeInNavigation |
Gets or sets a value indicating whether the navigation is included. |
boolean |
Required |
ImageFileId |
Gets or sets the image file identifier. |
integer |
None. |
Children |
Gets or sets the list of the children elements. |
Collection of integer |
None. |
Properties |
Gets or sets the Product Group properties. |
Collection of ProductGroupProperty |
None. |
Id |
Gets or sets the identifier. |
integer |
Required |
Name |
Gets or sets the name. |
string |
Max length: 100 |
ParentProductGroupId |
Gets or sets the parent product group identifier. |
integer |
None. |
NrOfChilds |
The number of child Product Groups. |
integer |
None. |
Response Formats
application/json, text/json
{ "ChangedTimestamp": "2021-12-02T20:19:35.8416088+01:00", "ShopGroupId": 1, "Sequence": 2, "Comment": "sample string 3", "SyncEnabled": true, "IsActive": true, "IncludeInNavigation": true, "ImageFileId": 1, "Children": [ 1, 2 ], "Properties": [ { "CultureId": 1, "Code": "sample string 1", "Value": "sample string 2" }, { "CultureId": 1, "Code": "sample string 1", "Value": "sample string 2" } ], "Id": 7, "Name": "sample string 8", "ParentProductGroupId": 1, "NrOfChilds": 9 }
application/xml, text/xml
<ProductGroup xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Id>7</Id> <Name>sample string 8</Name> <ParentProductGroupId>1</ParentProductGroupId> <NrOfChilds>9</NrOfChilds> <ChangedTimestamp>2021-12-02T20:19:35.8416088+01:00</ChangedTimestamp> <ShopGroupId>1</ShopGroupId> <Sequence>2</Sequence> <Comment>sample string 3</Comment> <SyncEnabled>true</SyncEnabled> <IsActive>true</IsActive> <IncludeInNavigation>true</IncludeInNavigation> <ImageFileId>1</ImageFileId> <Children> <ProductGroupId>1</ProductGroupId> <ProductGroupId>2</ProductGroupId> </Children> <Properties> <Property> <CultureId>1</CultureId> <Code>sample string 1</Code> <Value>sample string 2</Value> </Property> <Property> <CultureId>1</CultureId> <Code>sample string 1</Code> <Value>sample string 2</Value> </Property> </Properties> </ProductGroup>