Product groups

List of product groups.

Available methods

All available methods for resource product groups.

HTTP method Endpoint Description
[badge-blue GET] /product-groups List of all product groups
[badge-blue GET] /product-groups/{product_group_id} Detail of a specific product group


Get all product groups

Get a list of all product groups
[badge-blue GET] /product-groups

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
name string Name or part of the name of a product group No
store_id string The unique id for the store No
code string Code of the product group No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
product_groups ProductGroup[] List of all product groups
total_items integer Count of all found product groups


Get a product group

Get information about a specific product group
[badge-blue GET] /product-groups/{product_group_id}

Path parameters

Parameter name Type Description Mandatory (Yes/No)
product_groups_id string The unique id for the product group Yes

Response

Status code: 200 OK
Output structure : ProductGroup