Channels

Server

Download schema

Sales channels (dine-in, takeaway, delivery)

List channels

GET

https://common-api.karma.life

/api/v1/channels

List channels with optional filtering

List channels › query Parameters

locationId

number

Filter by location ID

entityType

string · enum

Filter by entity type

Enum values:

ITEM

LOCATION

MODIFIER

List channels › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Create channel

POST

https://common-api.karma.life

/api/v1/channels

Create a new channel with assignments

Create channel › Request Body

entityType

string · enum · required

Type of entity

Enum values:

ITEM

LOCATION

MODIFIER

Create channel › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Add channel assignment

POST

https://common-api.karma.life

/api/v1/channels/{channelId}/assignments

Add a new channel type assignment to an existing channel

Add channel assignment › path Parameters

channelId

string · required

Channel ID

Add channel assignment › Request Body

channelType

string · enum · required

Type of channel

Enum values:

KIOSK

POS

ONLINE

TAKEAWAY

isEnabled

boolean

Whether channel type is enabled

Default: true

Add channel assignment › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Get channel

GET

https://common-api.karma.life

/api/v1/channels/{id}

Get a single channel by ID with its assignments

Get channel › path Parameters

id

string · required

Channel ID

Get channel › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Update channel

PUT

https://common-api.karma.life

/api/v1/channels/{id}

Update an existing channel

Permissions: 🟠 channels.update

Update channel › path Parameters

id

string · required

Channel ID

Update channel › Request Body

isActive

boolean

Whether channel is active

Update channel › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Delete channel

DELETE

https://common-api.karma.life

/api/v1/channels/{id}

Delete a channel and its assignments

Delete channel › path Parameters

id

string · required

Channel ID

Delete channel › Responses

Channel successfully deleted

status

string · enum

Enum values:

success

object

Update channel assignment

PUT

https://common-api.karma.life

/api/v1/channels/assignments/{assignmentId}

Update an existing channel assignment

Update channel assignment › path Parameters

assignmentId

string · required

Assignment ID

Update channel assignment › Request Body

isEnabled

boolean

Whether channel type is enabled

Update channel assignment › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Delete channel assignment

DELETE

https://common-api.karma.life

/api/v1/channels/assignments/{assignmentId}

Delete a channel assignment

Permissions: 🔴 channels.delete

Delete channel assignment › path Parameters

assignmentId

string · required

Assignment ID

Delete channel assignment › Responses

Assignment successfully deleted

status

string · enum

Enum values:

success

object

Webhook: Channel created

POST

https://common-api.karma.life

/webhook/channel.created

Fired when a new sales channel is created. The full channel object is spread into data.

This is an outbound webhook event. Karma POSTs this payload to the URL you registered via POST /api/v1/webhooks/subscriptions. Your endpoint should respond 2xx within 30 seconds to acknowledge delivery.

Webhook: Channel created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

channel.created

resource

string · enum · required

Enum values:

channel

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Webhook: Channel created › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/channel.created

curl --request POST \
  --url https://common-api.karma.life/webhook/channel.created \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "channel.created",
  "resource": "channel",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "entityType": "MENU",
    "entityId": "entityId",
    "locationId": 0,
    "isActive": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "channel.created",
  "resource": "channel",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "entityType": "MENU",
    "entityId": "entityId",
    "locationId": 0,
    "isActive": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Channel updated

POST

https://common-api.karma.life

/webhook/channel.updated

Only the modified fields appear in changes.

Webhook: Channel updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

channel.updated

resource

string · enum · required

Enum values:

channel

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Channel updated › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Webhook: Channel deleted

POST

https://common-api.karma.life

/webhook/channel.deleted

Soft delete.

Webhook: Channel deleted › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

channel.deleted

resource

string · enum · required

Enum values:

channel

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Channel deleted › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Webhook: Channel assignment created

POST

https://common-api.karma.life

/webhook/channel.assignment.created

Fired when a channel is assigned to an entity (menu layout, item, etc.). May also trigger menu-layouts.updated or inventory.updated downstream.

Webhook: Channel assignment created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

channel.assignment.created

resource

string · enum · required

Enum values:

channel

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Channel assignment created › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/channel.assignment.created

curl --request POST \
  --url https://common-api.karma.life/webhook/channel.assignment.created \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "channel.assignment.created",
  "resource": "channel",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "channelId": "00000000-0000-0000-0000-000000000000",
    "assignment": {}
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "channel.assignment.created",
  "resource": "channel",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "channelId": "00000000-0000-0000-0000-000000000000",
    "assignment": {}
  }
}

json

Example Responses

No example specified for this content type

Webhook: Channel assignment updated

POST

https://common-api.karma.life

/webhook/channel.assignment.updated

May also trigger menu-layouts.updated or inventory.updated downstream.

Webhook: Channel assignment updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

channel.assignment.updated

resource

string · enum · required

Enum values:

channel

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Channel assignment updated › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/channel.assignment.updated

curl --request POST \
  --url https://common-api.karma.life/webhook/channel.assignment.updated \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "channel.assignment.updated",
  "resource": "channel",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "channelId": "00000000-0000-0000-0000-000000000000",
    "changes": {}
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "channel.assignment.updated",
  "resource": "channel",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "channelId": "00000000-0000-0000-0000-000000000000",
    "changes": {}
  }
}

json

Example Responses

No example specified for this content type

Webhook: Channel assignment deleted

POST

https://common-api.karma.life

/webhook/channel.assignment.deleted

May also trigger menu-layouts.updated or inventory.updated downstream.

Webhook: Channel assignment deleted › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

channel.assignment.deleted

resource

string · enum · required

Enum values:

channel

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Channel assignment deleted › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/channel.assignment.deleted

curl --request POST \
  --url https://common-api.karma.life/webhook/channel.assignment.deleted \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "channel.assignment.deleted",
  "resource": "channel",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "channelId": "00000000-0000-0000-0000-000000000000",
    "deletedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "channel.assignment.deleted",
  "resource": "channel",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "channelId": "00000000-0000-0000-0000-000000000000",
    "deletedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Capacity Settings Coursings