/api/v1/shop/order-group/list

Returns the organisation order groups in display order. Use active to decide whether a public page bound to a group (e.g. /lednice/{slug}) may offer anything: order create into an inactive group is rejected.

ordergetApiV1ShopOrder-groupList

Parameters

2 query

Query parameters

· 2

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

onlyActiveboolean | stringOptional

When true, only groups that accept new orders are returned.

Exampletrue

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

codestringRequired

Stable group code (slug, unique per organisation).

Examplelednice-smichov

namestringRequired

Display name.

ExampleLednice Smíchov

activebooleanRequired

Whether the group accepts new orders. Public sites should hide (404) anything bound to an inactive group.

defaultbooleanRequired

Whether this is the organisation default group.

positionnumberRequired

Sort order, unique 1..N within the organisation.

itemCountnumberRequired

Response example

application/json

{
  "items": [
    {
      "code": "lednice-smichov",
      "name": "Lednice Smíchov",
      "active": false,
      "default": false,
      "position": 0
    }
  ],
  "itemCount": 0
}

Request example

GET /api/v1/shop/order-group/list

get

curl -X GET "https://api.bizkithub.com/api/v1/shop/order-group/list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&onlyActive=true" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key