GET api/v7/GroupDetails/{groupCode}

Returns group detail record from the database.

Request Information

URI Parameters

NameDescriptionTypeRequired?Additional information
groupCode *

Group Code of the group record.

 string

Yes

None.

Body Parameters

None.

Response Information

Resource Description

A response containing an acknowledgment and the requested group detail information.

Collection of GroupProductResponseDto
NameDescriptionType
groupCode

Group Code

 string
groupName

Group Name

 string
productCode

Product Code

 string
groupTypeCode

Group Type Code

 string
groupTypeName

Group Type Name

 string
suggest

Auto suggest flag

 boolean
quantity

Quantity

 integer
order

Order

 integer
crossReferenceKeyCode

Cross Reference Key

 string
colorDescription

Color Description

 string
sizeDescription

Size Description

 string
sizePattern

Size Pattern

 string
filePath

File Path

 string
imageName

Image Path

 string
productCulture

Product Culture

 string
shortDescription

Short Description

 string
specialComments

Special Comments

 string
unitPrice

Unit Price

 decimal number
customerAuditDate

Last modified audit information

 date
productOrgFeatures

Collection of Org Feature Information of a product

 Collection of Product Org Feature Info
culture

Culture Code. For example: en-US, fr, fr-CA, es, ja-JP etc.

 string
description

Description Text (Culture specific)

 string

Response Formats

application/json, text/json

Sample: 
[
  {
    "groupCode": "sample string 1",
    "groupName": "sample string 2",
    "productCode": "sample string 3",
    "groupTypeCode": "sample string 4",
    "groupTypeName": "sample string 5",
    "suggest": true,
    "quantity": 1,
    "order": 1,
    "crossReferenceKeyCode": "sample string 6",
    "colorDescription": "sample string 7",
    "sizeDescription": "sample string 8",
    "sizePattern": "sample string 9",
    "filePath": "sample string 10",
    "imageName": "sample string 11",
    "productCulture": "sample string 12",
    "shortDescription": "sample string 13",
    "specialComments": "sample string 14",
    "unitPrice": 1.0,
    "customerAuditDate": "2018-01-01T00:00:00",
    "productOrgFeatures": [
      {
        "featureKey": "sample string 1",
        "featureData": {}
      },
      {
        "featureKey": "sample string 1",
        "featureData": {}
      }
    ],
    "culture": "sample string 15",
    "description": "sample string 16"
  },
  {
    "groupCode": "sample string 1",
    "groupName": "sample string 2",
    "productCode": "sample string 3",
    "groupTypeCode": "sample string 4",
    "groupTypeName": "sample string 5",
    "suggest": true,
    "quantity": 1,
    "order": 1,
    "crossReferenceKeyCode": "sample string 6",
    "colorDescription": "sample string 7",
    "sizeDescription": "sample string 8",
    "sizePattern": "sample string 9",
    "filePath": "sample string 10",
    "imageName": "sample string 11",
    "productCulture": "sample string 12",
    "shortDescription": "sample string 13",
    "specialComments": "sample string 14",
    "unitPrice": 1.0,
    "customerAuditDate": "2018-01-01T00:00:00",
    "productOrgFeatures": [
      {
        "featureKey": "sample string 1",
        "featureData": {}
      },
      {
        "featureKey": "sample string 1",
        "featureData": {}
      }
    ],
    "culture": "sample string 15",
    "description": "sample string 16"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfGroupProductResponseDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <GroupProductResponseDto>
    <culture>sample string 15</culture>
    <description>sample string 16</description>
    <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
    <groupCode>sample string 1</groupCode>
    <groupName>sample string 2</groupName>
    <productCode>sample string 3</productCode>
    <groupTypeCode>sample string 4</groupTypeCode>
    <groupTypeName>sample string 5</groupTypeName>
    <suggest>true</suggest>
    <quantity>1</quantity>
    <order>1</order>
    <crossReferenceKeyCode>sample string 6</crossReferenceKeyCode>
    <colorDescription>sample string 7</colorDescription>
    <sizeDescription>sample string 8</sizeDescription>
    <sizePattern>sample string 9</sizePattern>
    <filePath>sample string 10</filePath>
    <imageName>sample string 11</imageName>
    <productCulture>sample string 12</productCulture>
    <shortDescription>sample string 13</shortDescription>
    <specialComments>sample string 14</specialComments>
    <unitPrice>1</unitPrice>
    <productOrgFeatures>
      <ProductOrgFeatureInfo>
        <featureKey>sample string 1</featureKey>
        <featureData />
      </ProductOrgFeatureInfo>
      <ProductOrgFeatureInfo>
        <featureKey>sample string 1</featureKey>
        <featureData />
      </ProductOrgFeatureInfo>
    </productOrgFeatures>
  </GroupProductResponseDto>
  <GroupProductResponseDto>
    <culture>sample string 15</culture>
    <description>sample string 16</description>
    <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
    <groupCode>sample string 1</groupCode>
    <groupName>sample string 2</groupName>
    <productCode>sample string 3</productCode>
    <groupTypeCode>sample string 4</groupTypeCode>
    <groupTypeName>sample string 5</groupTypeName>
    <suggest>true</suggest>
    <quantity>1</quantity>
    <order>1</order>
    <crossReferenceKeyCode>sample string 6</crossReferenceKeyCode>
    <colorDescription>sample string 7</colorDescription>
    <sizeDescription>sample string 8</sizeDescription>
    <sizePattern>sample string 9</sizePattern>
    <filePath>sample string 10</filePath>
    <imageName>sample string 11</imageName>
    <productCulture>sample string 12</productCulture>
    <shortDescription>sample string 13</shortDescription>
    <specialComments>sample string 14</specialComments>
    <unitPrice>1</unitPrice>
    <productOrgFeatures>
      <ProductOrgFeatureInfo>
        <featureKey>sample string 1</featureKey>
        <featureData />
      </ProductOrgFeatureInfo>
      <ProductOrgFeatureInfo>
        <featureKey>sample string 1</featureKey>
        <featureData />
      </ProductOrgFeatureInfo>
    </productOrgFeatures>
  </GroupProductResponseDto>
</ArrayOfGroupProductResponseDto>