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

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/product-groups?store_id=83d1d11ea3884a5d33253fe214&name=Desserts
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZVcmZhY2U6YmVlZDA2ZjBmYhTEyUwOWIzNzk2ZjMODEEyZTIxNmVkMM5NDE5Zj2NzMwZmRj2w

Example response

HTTP/1.1 200 OK
Date: Tue, 29 Sep 2020 15:19:04 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "product_groups": [
      {
        "product_group_id": "87c4c16c6d82d44ab7f50d537e",
        "name": "Desserts",
        "parent_product_group_id": null,
        "code": null,
        "external_id": "53",
        "store_id": "83d1d11ea3884a5d33253fe214",
        "last_change": "2019-02-08 15:35:09",
        "state": 1
      }
    ],
    "total_items": 1
  }
}


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

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/product-groups/87c4c16c6d82d44ab7f50d537e
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZVcmZhY2U6YmVlZDA2ZjBmYhTEyUwOWIzNzk2ZjMODEEyZTIxNmVkMM5NDE5Zj2NzMwZmRj2w

Example response

HTTP/1.1 200 OK
Date: Tue, 29 Sep 2020 15:19:37 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "product_group_id": "87c4c16c6d82d44ab7f50d537e",
    "name": "Desserts",
    "parent_product_group_id": null,
    "code": null,
    "external_id": "53",
    "store_id": "83d1d11ea3884a5d33253fe214",
    "last_change": "2019-02-08 15:35:09",
    "state": 1
  }
}