Product groups

Use these methods to obtain information about the available product groups.

GET[host]/api/v2/my/products/groups

Get a list of product groups

GET[host]/api/v2/my/products/groups/{groupId}

Get product group details

Get a list of product groups

Use this method to obtain a list of the available product groups. A response includes only enabled product groups.

Request

Header parameters:

  • Authorization: Bearer <token>

Query parameters:

The following filter parameter is available for this method:

type

The product group type.

The following sorting parameters are available for this method:

caption

The product group name.

priority

The priority index assigned to a product group.

createTime

The date and time when a product group was created in the Back Office.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/my/products/groups

curl --location -g --request GET 'https://host.name/api/v2/my/products/groups?limit=10&offset=0&sort_order=desc&sort_by=createTime&filter[type]=default' \
--header 'Authorization: Bearer <token>'

Response

A response includes an array of Product Group objects providing information about the product groups matching the request parameters.

Get product group details

Use this method to obtain detailed information about a specified product group.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

groupId required

The product group identifier.

GET[host]/api/v2/my/products/groups/{groupId}

curl --location --request GET 'https://host.name/api/v2/my/products/groups/1' \
--header 'Authorization: Bearer <token>'

Response

A response contains a Product Group object providing information about the specified product group.