You are viewing a non-production environment — the API surface may differ from production.
Developers
Booking API

Capacity Settings

Time slot capacity configuration and limits

/api/v1/locations/{locationId}/capacity-settings

GET
/api/v1/locations/{locationId}/capacity-settings

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Path Parameters

locationId*string

Location ID

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/locations/string/capacity-settings"
{  "status": "success",  "data": {    "capacitySettings": [      {        "id": 0,        "locationId": 0,        "orderCapacity": null,        "itemCapacity": null,        "name": "string",        "priority": 0,        "enabled": true,        "timeStart": null,        "timeEnd": null,        "validFrom": null,        "validTo": null,        "validOnDays": [          0        ],        "createdAt": "string",        "updatedAt": "string"      }    ]  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

/api/v1/locations/{locationId}/capacity-settings

POST
/api/v1/locations/{locationId}/capacity-settings

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Path Parameters

locationId*string

Location ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderCapacity?|

Max orders per time slot

itemCapacity?|

Max items per time slot

name*string

Display name for this setting

priority?number

Sort order (lower = higher priority)

enabled?boolean
Defaulttrue
timeStart?|

HH:mm:ss format

timeEnd?|

HH:mm:ss format

validFrom?|

ISO timestamp

validTo?|

ISO timestamp

validOnDays*array<number>

Array of days (1-7, Monday-Sunday)

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/locations/string/capacity-settings" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "validOnDays": [      0    ]  }'
{  "status": "success",  "data": {    "capacitySetting": {      "id": 0,      "locationId": 0,      "orderCapacity": null,      "itemCapacity": null,      "name": "string",      "priority": 0,      "enabled": true,      "timeStart": null,      "timeEnd": null,      "validFrom": null,      "validTo": null,      "validOnDays": [        0      ],      "createdAt": "string",      "updatedAt": "string"    }  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

/api/v1/locations/{locationId}/capacity-settings/{id}

GET
/api/v1/locations/{locationId}/capacity-settings/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Path Parameters

locationId*string

Location ID

id*string

Capacity setting ID

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/locations/string/capacity-settings/string"
{  "status": "success",  "data": {    "capacitySetting": {      "id": 0,      "locationId": 0,      "orderCapacity": null,      "itemCapacity": null,      "name": "string",      "priority": 0,      "enabled": true,      "timeStart": null,      "timeEnd": null,      "validFrom": null,      "validTo": null,      "validOnDays": [        0      ],      "createdAt": "string",      "updatedAt": "string"    }  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

/api/v1/locations/{locationId}/capacity-settings/{id}

DELETE
/api/v1/locations/{locationId}/capacity-settings/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Path Parameters

locationId*string

Location ID

id*string

Capacity setting ID

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/locations/string/capacity-settings/string"
{  "status": "success",  "data": {    "deleted": true  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

/api/v1/locations/{locationId}/capacity-settings/{id}

PUT
/api/v1/locations/{locationId}/capacity-settings/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Path Parameters

locationId*string

Location ID

id*string

Capacity setting ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderCapacity?number|null
itemCapacity?number|null
name?string
priority?number
enabled?boolean
timeStart?string|null
timeEnd?string|null
validFrom?string|null
validTo?string|null
validOnDays?array<number>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/locations/string/capacity-settings/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "status": "success",  "data": {    "capacitySetting": {      "id": 0,      "locationId": 0,      "orderCapacity": null,      "itemCapacity": null,      "name": "string",      "priority": 0,      "enabled": true,      "timeStart": null,      "timeEnd": null,      "validFrom": null,      "validTo": null,      "validOnDays": [        0      ],      "createdAt": "string",      "updatedAt": "string"    }  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

/api/v1/locations/{locationId}/capacity-settings/reorder

PUT
/api/v1/locations/{locationId}/capacity-settings/reorder

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Path Parameters

locationId*string

Location ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderedIds*array<number>

Array of capacity setting IDs in desired priority order

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/locations/string/capacity-settings/reorder" \  -H "Content-Type: application/json" \  -d '{    "orderedIds": [      0    ]  }'
{  "status": "success",  "data": {    "capacitySettings": [      {        "id": 0,        "locationId": 0,        "orderCapacity": null,        "itemCapacity": null,        "name": "string",        "priority": 0,        "enabled": true,        "timeStart": null,        "timeEnd": null,        "validFrom": null,        "validTo": null,        "validOnDays": [          0        ],        "createdAt": "string",        "updatedAt": "string"      }    ]  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

Time Slots Settings

Location configuration for order time slots

Notes

Notes attached to tabs and orders