GET product/groups/{productGroupId}/members

List all product in the given product group

Note: Log in to check if your API client have access to run this resource
Version: 2
Success HTTP Status Code: 200
Maximum items from list ($top): 80

Uri parameters

{productGroupId} Integer Product group identifier

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold is required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

Active() Named filter Active group members
Deactivated() Named filter Deactivated group members
MemberId Integer Group member identifier.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductStatus Integer Status of the product.
Status Integer Product group membership status.

See the page about filters and sorting on how to use sortable parameters

MemberId Integer Group member identifier
ProductId Integer Product identifier
ProductName String Name of the product
ProductStatus Integer Status of the product
Status Integer Product group membership status

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Members>
2
     <Member>
3
          <MemberId
MemberId

Group member identifier

>
{Integer}</MemberId>
4
          <Status
Status

Product group membership status

>
{Integer}</Status>
5
          <AddedAt
AddedAt

Date and time of creation

>
{Datetime}</AddedAt>
6
          <RemovedAt
RemovedAt

Datetime when product was removed from group

>
{Datetime}</RemovedAt>
7
          <Product>
8
               <ProductId
ProductId

Product identifier

>
{Integer}</ProductId>
9
               <Status
Status

Status of the product

Possible domain values can be found here when logged in

>
{Integer}</Status>
10
               <Name
Name

Name of the product

>
{String}</Name>
11
               <Description
Description

Description of the product

>
{String}</Description>
12
               <ProductLink
ProductLink

Product reference

>
{String}</ProductLink>
13
          </Product>
14
          <AddedBy>
15
               <UserId
UserId

User identifier

>
{Integer}</UserId>
16
               <Name
Name

Name of the user

>
{String}</Name>
17
               <FirstName
FirstName

First name of the user

>
{String}</FirstName>
18
               <UserLink
UserLink

User reference

>
{String}</UserLink>
19
          </AddedBy>
20
          <RemovedBy>
21
               <UserId
UserId

User identifier

>
{Integer}</UserId>
22
               <Name
Name

Name of the user

>
{String}</Name>
23
               <FirstName
FirstName

First name of the user

>
{String}</FirstName>
24
               <UserLink
UserLink

User reference

>
{String}</UserLink>
25
          </RemovedBy>
26
          <MemberLink
MemberLink

Reference to product group member

>
{String}</MemberLink>
27
     </Member>
28
</Members>
1
{
2
     "members": [
3
          {
4
               "memberId
MemberId

Group member identifier

":
"{Integer}",
5
               "status
Status

Product group membership status

":
"{Integer}",
6
               "addedAt
AddedAt

Date and time of creation

":
"{Datetime}",
7
               "removedAt
RemovedAt

Datetime when product was removed from group

":
"{Datetime}",
8
               "product": {
9
                    "productId
ProductId

Product identifier

":
"{Integer}",
10
                    "status
Status

Status of the product

Possible domain values can be found here when logged in

":
"{Integer}",
11
                    "name
Name

Name of the product

":
"{String}",
12
                    "description
Description

Description of the product

":
"{String}",
13
                    "productLink
ProductLink

Product reference

":
"{String}"
14
               },
15
               "addedBy": {
16
                    "userId
UserId

User identifier

":
"{Integer}",
17
                    "name
Name

Name of the user

":
"{String}",
18
                    "firstName
FirstName

First name of the user

":
"{String}",
19
                    "userLink
UserLink

User reference

":
"{String}"
20
               },
21
               "removedBy": {
22
                    "userId
UserId

User identifier

":
"{Integer}",
23
                    "name
Name

Name of the user

":
"{String}",
24
                    "firstName
FirstName

First name of the user

":
"{String}",
25
                    "userLink
UserLink

User reference

":
"{String}"
26
               },
27
               "memberLink
MemberLink

Reference to product group member

":
"{String}"
28
          }
29
     ]
30
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 102663 HTTP 404 Product group not found
Error 101814 HTTP 404 Employee not found