GET product/groups

Get all product groups

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

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.
$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.

ContainingProductId Integer Product identifier.
Name String Name of product group.
NotContainingProductId Integer Product identifier.
ProductGroupId Integer Product group identifier.
Status Integer Status of product group.

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

ContainingProductId Integer Product identifier
Name String Name of product group
NotContainingProductId Integer Product identifier
ProductGroupId Integer Product group identifier
Status Integer Status of product group

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
<ProductGroups>
2
     <ProductGroup>
3
          <ProductGroupId
ProductGroupId

Product group identifier

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

Status of product group

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

Name of product group

>
{String}</Name>
6
          <ProductGroupLink
ProductGroupLink

Product group member reference

>
{String}</ProductGroupLink>
7
     </ProductGroup>
8
</ProductGroups>
1
{
2
     "productGroups": [
3
          {
4
               "productGroupId
ProductGroupId

Product group identifier

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

Status of product group

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

Name of product group

":
"{String}",
7
               "productGroupLink
ProductGroupLink

Product group member reference

":
"{String}"
8
          }
9
     ]
10
}

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: