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


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