Store groups

List of store groups.

Available methods

All available methods for resource store groups.

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


Get all store groups

Get a list of all store groups
[badge-blue GET] /store-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 store group No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
store_groups StoreGroup[] List of all store groups
total_items integer Count of all found store groups

Example Request

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

Example response

HTTP/1.1 200 OK
Date: Wed, 09 Dec 2020 14:09:33 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "store_groups": [
      {
        "store_group_id": "8bed991c68a470e7aaeffbf048",
        "name": "Groceries",
        "last_change": "2020-08-24 10:14:00"
      }
    ],
    "total_items": 1
  }
}


Get a store group

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

Path parameters

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

Response

Status code: 200 OK
Output structure : StoreGroup

Example Request

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

Example response

HTTP/1.1 200 OK
Date: Wed, 09 Dec 2020 14:11:26 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "store_group_id": "8bed991c68a470e7aaeffbf048",
    "name": "Groceries",
    "last_change": "2020-08-24 10:14:00"
  }
}