/api/v1/shop/order-group/set-active

An inactive group accepts no new orders and is never re-activated by order-group auto-creation. Existing orders stay untouched. The default group cannot be deactivated.

orderpostApiV1ShopOrder-groupSet-active

Parameters

1 query · JSON body

Query parameters

· 1

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

Request body

application/json

codestringRequired

Code of the group.

Examplelednice-smichov

activebooleanRequired

true activates the group, false deactivates it.

Response schema

1 status code documented

200Success

successbooleanRequired

Default: true

Response example

application/json

{
  "success": true
}

Request example

POST /api/v1/shop/order-group/set-active

post

curl -X POST "https://api.bizkithub.com/api/v1/shop/order-group/set-active?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "code": "lednice-smichov",
  "active": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key