POST product/groups

Create a new product group

Note: Log in to check if your API client have access to run this resource
Version: 2
Success HTTP Status Code: 201

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
<ProductGroup>
2
     <Name
Name

Required/mandatory field

Name of product group

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

Description of the product group

This field is optional.

>
{String}</Description>
4
</ProductGroup>
1
{
2
     "productGroup": {
3
          "name
Name

Required/mandatory field

Name of product group

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

Description of the product group

This field is optional.

":
"{String}"
5
     }
6
}

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.

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

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

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

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

Format:
1
<ProductGroup>
2
     <ProductGroupId
ProductGroupId

Product group identifier

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

Status of product group

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

Date and time of creation

>
{Datetime}</CreatedAt>
5
     <Name
Name

Name of product group

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

Description of the product group

>
{String}</Description>
7
</ProductGroup>
1
{
2
     "productGroup": {
3
          "productGroupId
ProductGroupId

Product group identifier

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

Status of product group

":
"{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

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

Name of product group

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

Description of the product group

":
"{String}"
8
     }
9
}

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 102664 HTTP 400 Name of product group is required
Error 102663 HTTP 404 Product group not found
Error 102665 HTTP 400 A product group with that name already exists