Tabs

Server

Download schema

Customer tabs and running bills

Get Adyen payment methods

GET

https://common-api.karma.life

/api/v1/tab/{tabId}/payment-methods

Returns available Adyen payment methods for the Advanced flow. No purchase is created.

Get Adyen payment methods › path Parameters

tabId

string · uuid · required

Tab UUID

Get Adyen payment methods › query Parameters

amountCents

number · min: 0 · required

Payment amount in cents. 0 is a valid value: the storefront still hits this endpoint when the cart nets to 0 (voucher fully covers the order) and the handler short-circuits with an empty paymentMethodsResponse so the drawer can route to the complimentary settlement path without a PSP method selection.

currencyCode

string · required

ISO 4217 currency code (e.g. SEK, EUR)

countryCode

string

ISO 3166-1 alpha-2 country code (e.g. SE, NL)

tabMemberId

string · uuid

Optional tab member UUID. When supplied, the handler resolves the paying user and includes a shopperReference so Adyen returns storedPaymentMethods (saved cards) for the shopper. Omit for guest checkouts.

Get Adyen payment methods › Responses

Payment methods fetched successfully

status

string · enum

Enum values:

success

object

meta

object

GET/api/v1/tab/{tabId}/payment-methods

curl --request GET \
  --url 'https://common-api.karma.life/api/v1/tab/:tabId/payment-methods?amountCents=%3Cnumber%3E&currencyCode=%3Cstring%3E'

Example Responses

No example specified for this content type

application/json

Cancel tab payment

POST

https://common-api.karma.life

/api/v1/tab/cancel

Cancel a pending tab payment by purchase intent ID

Permissions: 🟠 tabs.update

Cancel tab payment › Request Body

purchase_intent_id

string · uuid · required

Purchase intent ID to cancel

Cancel tab payment › Responses

Payment canceled successfully

status

string · enum

Enum values:

success

object

meta

object

POST/api/v1/tab/cancel

curl --request POST \
  --url https://common-api.karma.life/api/v1/tab/cancel \
  --header 'Content-Type: application/json' \
  --data '
{
  "purchase_intent_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "purchase_intent_id": "00000000-0000-0000-0000-000000000000"
}

Example Responses

No example specified for this content type

application/json

Cancel all tab payments

POST

https://common-api.karma.life

/api/v1/tab/cancel-all

Cancel all pending payments for a specific tab

Permissions: 🟠 tabs.update

Cancel all tab payments › Request Body

tab_id

string · uuid · required

Tab ID to cancel all payments for

Cancel all tab payments › Responses

All payments canceled successfully

status

string · enum

Enum values:

success

object

meta

object

POST/api/v1/tab/cancel-all

curl --request POST \
  --url https://common-api.karma.life/api/v1/tab/cancel-all \
  --header 'Content-Type: application/json' \
  --data '
{
  "tab_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "tab_id": "00000000-0000-0000-0000-000000000000"
}

Example Responses

No example specified for this content type

application/json

Pay for tab

POST

https://common-api.karma.life

/api/v1/tab/pay

Process a payment for a tab using various payment methods

Permissions: 🟠 tabs.update

Pay for tab › Request Body

tab_id

string · uuid · required

UUID of the tab to pay for

payment_method

string · enum · required

Payment method to use

Enum values:

prepaid

invoice

swish

terminal

online

gift_card

tab_member_id

string

ID of the tab member making the payment (UUID). Optional - will be auto-resolved from JWT token if not provided.

kitchen_dispatch_items

string[]

Array of kitchen dispatch item IDs to pay for (ITEM mode)

amount_cents

number · min: 0

Amount to pay in cents (AMOUNT mode or triggers mode switch)

terminal_id

string · uuid

Terminal ID (required for terminal payments)

return_url

string · uri

Return URL after payment (required for online/swish payments)

tip_amount_cents

number · min: 0

Tip amount in cents

Default: 0

metadata

object

Additional metadata for the payment

voucher_codes

string[]

Voucher codes to apply to the payment

recipient_id

string · uuid

Invoice recipient UUID (for invoice payments)

gift_card_code

string

Gift card code for gift_card payment method (format: XXXX-XXXX-XXXX)

object

Adyen payment method data from Drop-in/Components (triggers Advanced flow when present)

cancel_existing_payment

boolean

User confirmed: cancel the in-progress Adyen CS payment and start a new one

save_payment_method

boolean

When true, persist the card token after Adyen Authorised so the user can re-use it. Default false. Honored when location has the instant_pay_v2 feature flag enabled.

selected_saved_payment_method_id

string

UUID of a previously saved payment method to charge. Forwarded to payment-service alongside the Adyen Advanced PSP payload.

Pay for tab › Responses

Payment initiated successfully

status

string · enum

Enum values:

success

object

meta

object

POST/api/v1/tab/pay

curl --request POST \
  --url https://common-api.karma.life/api/v1/tab/pay \
  --header 'Content-Type: application/json' \
  --data '
{
  "tab_id": "00000000-0000-0000-0000-000000000000",
  "tab_member_id": "tab_member_id",
  "payment_method": "prepaid",
  "kitchen_dispatch_items": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "amount_cents": 0,
  "terminal_id": "00000000-0000-0000-0000-000000000000",
  "return_url": "https://www.example.com/path/to/resource",
  "tip_amount_cents": 0,
  "metadata": {},
  "voucher_codes": [
    "string"
  ],
  "recipient_id": "00000000-0000-0000-0000-000000000000",
  "gift_card_code": "gift_card_code",
  "payment_data": {},
  "cancel_existing_payment": true,
  "save_payment_method": true,
  "selected_saved_payment_method_id": "selected_saved_payment_method_id"
}
'

Example Request Body

{
  "tab_id": "00000000-0000-0000-0000-000000000000",
  "tab_member_id": "tab_member_id",
  "payment_method": "prepaid",
  "kitchen_dispatch_items": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "amount_cents": 0,
  "terminal_id": "00000000-0000-0000-0000-000000000000",
  "return_url": "https://www.example.com/path/to/resource",
  "tip_amount_cents": 0,
  "metadata": {},
  "voucher_codes": [
    "string"
  ],
  "recipient_id": "00000000-0000-0000-0000-000000000000",
  "gift_card_code": "gift_card_code",
  "payment_data": {},
  "cancel_existing_payment": true,
  "save_payment_method": true,
  "selected_saved_payment_method_id": "selected_saved_payment_method_id"
}

Example Responses

No example specified for this content type

application/json

Submit Adyen payment details

POST

https://common-api.karma.life

/api/v1/tab/pay/details

Submit additional payment details (3DS, redirect) for an existing Adyen Advanced flow purchase.

Submit Adyen payment details › Request Body

purchase_intent_id

string · uuid · required

Purchase intent ID from the initial /tab/pay response

object · required

Adyen payment details object (from onAdditionalDetails callback)

Submit Adyen payment details › Responses

Payment details processed successfully

status

string · enum

Enum values:

success

object

meta

object

POST/api/v1/tab/pay/details

curl --request POST \
  --url https://common-api.karma.life/api/v1/tab/pay/details \
  --header 'Content-Type: application/json' \
  --data '
{
  "purchase_intent_id": "00000000-0000-0000-0000-000000000000",
  "details": {}
}
'

Example Request Body

{
  "purchase_intent_id": "00000000-0000-0000-0000-000000000000",
  "details": {}
}

Example Responses

No example specified for this content type

application/json

Recalculate tab balance

POST

https://common-api.karma.life

/api/v1/tab/recalculate

Recalculate tab balance from source of truth (kitchen dispatch items and purchases). Useful for fixing tabs with incorrect balance values.

Permissions: 🟠 tabs.update

Recalculate tab balance › Request Body

tab_id

string · uuid · required

Tab ID to recalculate balance for

Recalculate tab balance › Responses

Tab balance recalculated successfully

status

string · enum

Enum values:

success

object

meta

object

POST/api/v1/tab/recalculate

curl --request POST \
  --url https://common-api.karma.life/api/v1/tab/recalculate \
  --header 'Content-Type: application/json' \
  --data '
{
  "tab_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "tab_id": "00000000-0000-0000-0000-000000000000"
}

Example Responses

No example specified for this content type

application/json

List tabs

GET

https://common-api.karma.life

/api/v1/tabs

List tabs with optional filtering

Permissions: 🔵 tabs.read

List tabs › query Parameters

locationId

number

Filter by location ID

state

string · enum

Filter by tab state

Enum values:

initiated

started

instant

closed

settled

aborted

action_required

storefrontQrCodeId

string

Filter by table/QR code UUID

page

number · min: 1

Page number

Default: 1

limit

number · min: 1 · max: 100

Items per page

Default: 20

List tabs › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

GET/api/v1/tabs

curl --request GET \
  --url https://common-api.karma.life/api/v1/tabs

Example Responses

No example specified for this content type

application/json

Get tab details

GET

https://common-api.karma.life

/api/v1/tabs/{id}

Get a single tab by ID with members and kitchen dispatch items

Permissions: 🔵 tabs.read

Get tab details › path Parameters

id

string · uuid · required

Tab UUID

Get tab details › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

GET/api/v1/tabs/{id}

curl --request GET \
  --url https://common-api.karma.life/api/v1/tabs/:id

Example Responses

No example specified for this content type

application/json

Close a tab

POST

https://common-api.karma.life

/api/v1/tabs/{id}/close

Close a tab by setting its state to closed or aborted. Use force=true to close any tab regardless of state.

Permissions: 🟠 tabs.update

Close a tab › path Parameters

id

string · uuid · required

Tab UUID

Close a tab › Request Body

comment

string

Optional comment explaining why the tab is being closed

force

boolean

If true, forces the tab to close (state becomes "aborted"). If false, normal close (state becomes "closed") and only works on non-closed tabs

Default: false

Close a tab › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/{id}/close

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:id/close \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "comment",
  "force": false
}
'

Example Request Body

{
  "comment": "comment",
  "force": false
}

Example Responses

No example specified for this content type

application/json

Advance tab coursing

PATCH

https://common-api.karma.life

/api/v1/tabs/{id}/coursing

Advance the coursing order for a tab. If coursingOrder is provided in the body, sets to that specific value. Otherwise, advances to the next available coursing level from the location's coursings. Used for POS coursing feature to control when items from each course can be sent to the kitchen.

Permissions: 🟠 tabs.update

Advance tab coursing › path Parameters

id

string · uuid · required

Tab UUID

Advance tab coursing › Request Body

coursingOrder

number | null

Specific coursing order to set. If omitted, advances to the next available coursing level.

Advance tab coursing › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

PATCH/api/v1/tabs/{id}/coursing

curl --request PATCH \
  --url https://common-api.karma.life/api/v1/tabs/:id/coursing \
  --header 'Content-Type: application/json' \
  --data '
{
  "coursingOrder": 0
}
'

Example Request Body

{
  "coursingOrder": 0
}

Example Responses

No example specified for this content type

application/json

Debug: single tab

GET

https://common-api.karma.life

/api/v1/tabs/{id}/debug

Debug endpoint for a specific tab with detailed balance verification, per-item allocation breakdowns, and per-purchase line item details. Useful for diagnosing individual tab balance issues.

Permissions: 🔵 tabs.read

Debug: single tab › path Parameters

id

string · required

Tab UUID

Debug: single tab › Responses

Detailed debug info for a single tab

status

string · enum

Enum values:

success

object

GET/api/v1/tabs/{id}/debug

curl --request GET \
  --url https://common-api.karma.life/api/v1/tabs/:id/debug

Example Responses

No example specified for this content type

application/json

Join a tab by its UUID

POST

https://common-api.karma.life

/api/v1/tabs/{id}/join

Join a specific tab directly by UUID — no QR code required.

Used by the direct tab link feature (?tab=UUID in storefront-web). Returns 400 if the tab is closed/settled. Idempotent — safe to call multiple times with the same identifier.

Permissions: 🔵 tabs.read

Join a tab by its UUID › path Parameters

id

string · uuid · required

Tab UUID

Join a tab by its UUID › Request Body

object · required

User identification using priority system

Join a tab by its UUID › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/{id}/join

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:id/join \
  --header 'Content-Type: application/json' \
  --data '
{
  "tabMember": {
    "id": 0,
    "email": "test@example.com",
    "phone": "phone",
    "identifier": "identifier"
  }
}
'

Example Request Body

{
  "tabMember": {
    "id": 0,
    "email": "test@example.com",
    "phone": "phone",
    "identifier": "identifier"
  }
}

Example Responses

No example specified for this content type

application/json

Add a member to a tab

POST

https://common-api.karma.life

/api/v1/tabs/{id}/members

Add a user as a member to an existing tab. Looks up user by userId (priority 1), email (priority 2), or phone (priority 3). If user is already a member, returns existing member. Useful for POS "Add Loyalty Member" functionality.

Permissions: 🟠 tabs.update

Add a member to a tab › path Parameters

id

string · uuid · required

Tab UUID

Add a member to a tab › Request Body

At least one of userId, email, or phone is required. Resolution priority: userId > email > phone

userId

number

User ID (Priority 1 - direct lookup)

email

string · email

Email address (Priority 2 - lookup by email)

phone

string

Phone number (Priority 3 - lookup by phone)

Add a member to a tab › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/{id}/members

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:id/members \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": 0,
  "email": "test@example.com",
  "phone": "phone"
}
'

Example Request Body

{
  "userId": 0,
  "email": "test@example.com",
  "phone": "phone"
}

Example Responses

No example specified for this content type

application/json

Remove a tab member

DELETE

https://common-api.karma.life

/api/v1/tabs/{id}/members/{memberUuid}

Delete a tab member row. Refuses with 409 MEMBER_HAS_ORDERS when the member is referenced by any kitchen dispatch, settlement, voucher reservation, purchase, or comment (history is never cascade-deleted). Refuses with 409 CANNOT_REMOVE_INITIATOR for the initiator member. Use this from the POS guests tab to remove guests added by mistake.

Permissions: 🟠 tabs.update

Remove a tab member › path Parameters

id

string · uuid · required

Tab UUID

memberUuid

string · uuid · required

Tab member UUID to remove

Remove a tab member › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

DELETE/api/v1/tabs/{id}/members/{memberUuid}

curl --request DELETE \
  --url https://common-api.karma.life/api/v1/tabs/:id/members/:memberUuid

Example Responses

No example specified for this content type

application/json

Upsert guest contact on a tab member

PATCH

https://common-api.karma.life

/api/v1/tabs/{id}/members/{memberUuid}/contact

Overwrite email/phone/name on the user row attached to an anonymous tab member. Mirrors the kiosk-commit contact-overwrite semantics so a kiosk pay-upfront flow can record the guest's email before payment (avoiding "no recipient address on file" skips on the receipt-email cloud function). Registered accounts (users.guest=false) are refused — use the identify endpoint for those.

Permissions: 🟠 tabs.update

Upsert guest contact on a tab member › path Parameters

id

string · uuid · required

Tab UUID

memberUuid

string · uuid · required

Tab member UUID

Upsert guest contact on a tab member › Request Body

At least one of email, phone, or name is required. Non-empty fields are written to the tab member's user row; empty fields are ignored. Only applies to anonymous guest users (users.guest=true).

email

string · email

Guest email (overwrites existing non-empty value)

phone

string

Guest phone (overwrites existing non-empty value)

name

string

Guest name (overwrites existing non-empty value)

Upsert guest contact on a tab member › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

PATCH/api/v1/tabs/{id}/members/{memberUuid}/contact

curl --request PATCH \
  --url https://common-api.karma.life/api/v1/tabs/:id/members/:memberUuid/contact \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "test@example.com",
  "phone": "phone",
  "name": "name"
}
'

Example Request Body

{
  "email": "test@example.com",
  "phone": "phone",
  "name": "name"
}

Example Responses

No example specified for this content type

application/json

Identify an anonymous tab member

PATCH

https://common-api.karma.life

/api/v1/tabs/{id}/members/{memberUuid}/identify

Link an anonymous tab member to a known user. Looks up user by userId (priority 1), email (priority 2), or phone (priority 3), then updates the tab member record to associate with that user. Useful for POS "Identify Guest" functionality when an anonymous guest needs to be linked to their loyalty account.

Permissions: 🟠 tabs.update

Identify an anonymous tab member › path Parameters

id

string · uuid · required

Tab UUID

memberUuid

string · uuid · required

Tab member UUID to identify

Identify an anonymous tab member › Request Body

At least one of userId, email, or phone is required. Resolution priority: userId > email > phone

userId

number

User ID (Priority 1 - direct lookup)

email

string · email

Email address (Priority 2 - lookup by email)

phone

string

Phone number (Priority 3 - lookup by phone)

Identify an anonymous tab member › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

PATCH/api/v1/tabs/{id}/members/{memberUuid}/identify

curl --request PATCH \
  --url https://common-api.karma.life/api/v1/tabs/:id/members/:memberUuid/identify \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": 0,
  "email": "test@example.com",
  "phone": "phone"
}
'

Example Request Body

{
  "userId": 0,
  "email": "test@example.com",
  "phone": "phone"
}

Example Responses

No example specified for this content type

application/json

Settle a fully paid tab

POST

https://common-api.karma.life

/api/v1/tabs/{id}/settle

Settle a tab when its remaining balance is 0. This endpoint:

Validates the tab can be settled:
- Tab must exist
- Tab must have remaining_balance_cents = 0 (fully paid)
- Tab must not already be closed/settled/aborted
Updates the tab state to 'settled'
Converts amount payments to proportional item allocations (if any):
- Amount payments (type='amount') get converted to product allocations
- Each payer gets a proportional share of each item based on their pre-discount payment value
- Original amount line items get quantity_cents set to 0 to mark as converted

Use cases:

When balance reaches 0 via payments
Manual settlement by staff
This is the single source of truth for settling tabs

Note: If all payments were for specific items (ITEM mode), no conversion is needed.

Permissions: 🟠 tabs.update

Settle a fully paid tab › path Parameters

id

string · uuid · required

Tab UUID

Settle a fully paid tab › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/{id}/settle

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:id/settle

Example Responses

No example specified for this content type

application/json

Get tab timeline

GET

https://common-api.karma.life

/api/v1/tabs/{id}/timeline

Get a unified timeline of all events for a specific tab, including state transitions, order events, member joins, and payments. Events are sorted by creation time descending.

Permissions: 🔵 tabs.read

Get tab timeline › path Parameters

id

string · uuid · required

Tab UUID

Get tab timeline › Responses

Tab timeline events

status

string · enum · required

Enum values:

success

object · required

GET/api/v1/tabs/{id}/timeline

curl --request GET \
  --url https://common-api.karma.life/api/v1/tabs/:id/timeline

Example Responses

No example specified for this content type

application/json

Get checkout summary

POST

https://common-api.karma.life

/api/v1/tabs/{tabId}/checkout-summary

Get checkout summary for a tab member's locked items. Returns items, totals, VAT breakdown, and kitchenDispatchItems array for payment processing.

Get checkout summary › path Parameters

tabId

string · uuid · required

Tab UUID

Get checkout summary › Request Body

object · required

Tab member identification. Provide at least one identifier. Priority: id > email > phone > identifier

Get checkout summary › Responses

Checkout summary retrieved successfully

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/{tabId}/checkout-summary

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/checkout-summary \
  --header 'Content-Type: application/json' \
  --data '
{
  "tabMember": {
    "id": "id",
    "email": "email",
    "phone": "phone",
    "identifier": "identifier"
  }
}
'

Example Request Body

{
  "tabMember": {
    "id": "id",
    "email": "email",
    "phone": "phone",
    "identifier": "identifier"
  }
}

Example Responses

No example specified for this content type

application/json

Get tab discounts

GET

https://common-api.karma.life

/api/v1/tabs/{tabId}/discounts

Retrieve all items with discounts or price changes on a tab

Get tab discounts › path Parameters

tabId

string · uuid · required

UUID of the tab

Get tab discounts › query Parameters

changeType

string · enum

Filter by type of price change

Enum values:

DISCOUNT_PERCENTAGE

DISCOUNT_FIXED

PRICE_SET

DISCOUNT_REMOVED

appliedBy

integer

Filter by retailer user ID who applied the change

Get tab discounts › Responses

Default Response

status

string · enum · required

Response status

Enum values:

success

object · required

GET/api/v1/tabs/{tabId}/discounts

curl --request GET \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/discounts

Example Responses

No example specified for this content type

application/json

Get selected items

GET

https://common-api.karma.life

/api/v1/tabs/{tabId}/items

Get current selected items state for a tab

Get selected items › path Parameters

tabId

string · uuid · required

UUID of the tab

Get selected items › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

GET/api/v1/tabs/{tabId}/items

curl --request GET \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/items

Example Responses

No example specified for this content type

application/json

Remove item discount

DELETE

https://common-api.karma.life

/api/v1/tabs/{tabId}/items/{itemId}/discount

Remove any discount from an item and restore its base price

Remove item discount › path Parameters

tabId

string · uuid · required

UUID of the tab containing the item

itemId

string · uuid · required

UUID of the kitchen dispatch item to restore

Remove item discount › Request Body

reasonCode

string · required

Reason code for removing the discount

notes

string

Optional notes

Remove item discount › Responses

Default Response

status

string · enum · required

Response status

Enum values:

success

object · required

DELETE/api/v1/tabs/{tabId}/items/{itemId}/discount

curl --request DELETE \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/items/:itemId/discount \
  --header 'Content-Type: application/json' \
  --data '
{
  "reasonCode": "reasonCode",
  "notes": "notes"
}
'

Example Request Body

{
  "reasonCode": "reasonCode",
  "notes": "notes"
}

Example Responses

No example specified for this content type

application/json

Update item price

PUT

https://common-api.karma.life

/api/v1/tabs/{tabId}/items/{itemId}/price

Apply a discount or set a new price on a kitchen dispatch item

Update item price › path Parameters

tabId

string · uuid · required

UUID of the tab containing the item

itemId

string · uuid · required

UUID of the kitchen dispatch item to modify

Update item price › Request Body

action

string · enum · required

Type of action: "discount" for applying discounts, "set_price" for setting arbitrary price

Enum values:

discount

set_price

reasonCode

string · required

Required reason code explaining why the price is being adjusted

Example: PRICE_MATCH

discountType

string · enum

Required when action is "discount": type of discount to apply

Enum values:

percentage

fixed

value

number · min: 0

Required when action is "discount": percentage (1-100) or cents for fixed discount

priceInCents

integer · min: 0

Required when action is "set_price": new price in cents

notes

string

Optional notes providing additional context for the price adjustment

Update item price › Responses

Default Response

status

string · enum · required

Response status

Enum values:

success

object · required

PUT/api/v1/tabs/{tabId}/items/{itemId}/price

curl --request PUT \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/items/:itemId/price \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "discount",
  "discountType": "percentage",
  "value": 0,
  "priceInCents": 0,
  "reasonCode": "PRICE_MATCH",
  "notes": "notes"
}
'

Example Request Body

{
  "action": "discount",
  "discountType": "percentage",
  "value": 0,
  "priceInCents": 0,
  "reasonCode": "PRICE_MATCH",
  "notes": "notes"
}

Example Responses

No example specified for this content type

application/json

Get item price history

GET

https://common-api.karma.life

/api/v1/tabs/{tabId}/items/{itemId}/price-history

Retrieve the complete price change history for a kitchen dispatch item

Get item price history › path Parameters

tabId

string · uuid · required

UUID of the tab

itemId

string · uuid · required

UUID of the kitchen dispatch item

Get item price history › Responses

Default Response

status

string · enum · required

Response status

Enum values:

success

object · required

GET/api/v1/tabs/{tabId}/items/{itemId}/price-history

curl --request GET \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/items/:itemId/price-history

Example Responses

No example specified for this content type

application/json

Batch claim and unclaim items

POST

https://common-api.karma.life

/api/v1/tabs/{tabId}/items/batch

Atomically claim and unclaim items for a tab member in a single operation. Emits a single webhook event for the combined change.

Batch claim and unclaim items › path Parameters

tabId

string · uuid · required

UUID of the tab

Batch claim and unclaim items › Request Body

tabMemberId

string · uuid · required

UUID of the tab member performing the batch operation

clientId

string · uuid · required

UUID of the client (from storefront sessions)

claim

string[]

Item IDs to claim (UUIDs in ITEM mode, virtual IDs like "split-index-N" in AMOUNT mode)

unclaim

string[]

Item IDs to unclaim (UUIDs in ITEM mode, virtual IDs like "split-index-N" in AMOUNT mode)

mode

string · enum

Payment mode for the batch operation

Enum values:

ITEM

AMOUNT

Batch claim and unclaim items › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/{tabId}/items/batch

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/items/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "tabMemberId": "00000000-0000-0000-0000-000000000000",
  "clientId": "00000000-0000-0000-0000-000000000000",
  "claim": [
    "string"
  ],
  "unclaim": [
    "string"
  ],
  "mode": "ITEM"
}
'

Example Request Body

{
  "tabMemberId": "00000000-0000-0000-0000-000000000000",
  "clientId": "00000000-0000-0000-0000-000000000000",
  "claim": [
    "string"
  ],
  "unclaim": [
    "string"
  ],
  "mode": "ITEM"
}

Example Responses

No example specified for this content type

application/json

Bulk update item prices

PUT

https://common-api.karma.life

/api/v1/tabs/{tabId}/items/bulk-price

Apply discounts or set new prices on multiple kitchen dispatch items in a single request. Only sends items that need to be updated.

Bulk update item prices › path Parameters

tabId

string · uuid · required

UUID of the tab containing the items

Bulk update item prices › Request Body

object[] · minItems: 1 · required

Array of items to update. Each item should specify exactly one of: newPrice, discountPercent, or removeDiscount

reasonCode

string · required

Reason code explaining why the prices are being adjusted

Example: PRICE_MATCH

notes

string

Optional notes providing additional context for the price adjustments

Bulk update item prices › Responses

Default Response

status

string · enum · required

Response status

Enum values:

success

object · required

PUT/api/v1/tabs/{tabId}/items/bulk-price

curl --request PUT \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/items/bulk-price \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "kitchenDispatchItemId": "00000000-0000-0000-0000-000000000000",
      "newPrice": 0,
      "discountPercent": 0,
      "removeDiscount": true
    }
  ],
  "reasonCode": "PRICE_MATCH",
  "notes": "notes"
}
'

Example Request Body

{
  "items": [
    {
      "kitchenDispatchItemId": "00000000-0000-0000-0000-000000000000",
      "newPrice": 0,
      "discountPercent": 0,
      "removeDiscount": true
    }
  ],
  "reasonCode": "PRICE_MATCH",
  "notes": "notes"
}

Example Responses

No example specified for this content type

application/json

Claim items

POST

https://common-api.karma.life

/api/v1/tabs/{tabId}/items/claim

Claim specific items for a tab member

Claim items › path Parameters

tabId

string · uuid · required

UUID of the tab

Claim items › Request Body

tabMemberId

string · uuid · required

UUID of the tab member claiming the items

clientId

string · uuid · required

UUID of the client (from storefront sessions) for storage efficiency

items

string[] · minItems: 1 · required

Array of item IDs to claim. In ITEM mode: inventory item UUIDs. In AMOUNT mode: virtual IDs like "split-index-0".

mode

string · enum

Payment mode: ITEM for individual item claiming, AMOUNT for split claiming

Enum values:

ITEM

AMOUNT

Claim items › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/{tabId}/items/claim

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/items/claim \
  --header 'Content-Type: application/json' \
  --data '
{
  "tabMemberId": "00000000-0000-0000-0000-000000000000",
  "clientId": "00000000-0000-0000-0000-000000000000",
  "items": [
    "string"
  ],
  "mode": "ITEM"
}
'

Example Request Body

{
  "tabMemberId": "00000000-0000-0000-0000-000000000000",
  "clientId": "00000000-0000-0000-0000-000000000000",
  "items": [
    "string"
  ],
  "mode": "ITEM"
}

Example Responses

No example specified for this content type

application/json

Lock item selections

POST

https://common-api.karma.life

/api/v1/tabs/{tabId}/items/lock

Lock a tab member's selections for checkout (prevents further modifications)

Lock item selections › path Parameters

tabId

string · uuid · required

UUID of the tab

Lock item selections › Request Body

UUID of the tab member to lock/unlock selections for (nullable)

clientId

string · uuid

UUID of the client (fallback identifier when tabMemberId is not available)

claimAfterUnlock

boolean

If true, freed items are re-claimed to the caller after force-unlock of another member.

skipCascadeCancel

boolean

When true, bypass the auto-cancel of any payment_in_progress settlements for the unlocked member. Use only for staff force-unlock flows. Default false.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: tabMemberId
	type = object · requires: clientId

Properties for Variant 1:

required

UUID of the tab member to lock/unlock selections for (nullable)

clientId

string · uuid

UUID of the client (fallback identifier when tabMemberId is not available)

claimAfterUnlock

boolean

If true, freed items are re-claimed to the caller after force-unlock of another member.

skipCascadeCancel

boolean

When true, bypass the auto-cancel of any payment_in_progress settlements for the unlocked member. Use only for staff force-unlock flows. Default false.

Lock item selections › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/{tabId}/items/lock

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/items/lock \
  --header 'Content-Type: application/json' \
  --data '
{
  "tabMemberId": "00000000-0000-0000-0000-000000000000",
  "clientId": "00000000-0000-0000-0000-000000000000",
  "claimAfterUnlock": true,
  "skipCascadeCancel": true
}
'

Example Request Body

{
  "tabMemberId": "00000000-0000-0000-0000-000000000000",
  "clientId": "00000000-0000-0000-0000-000000000000",
  "claimAfterUnlock": true,
  "skipCascadeCancel": true
}

Example Responses

No example specified for this content type

application/json

Unclaim items

POST

https://common-api.karma.life

/api/v1/tabs/{tabId}/items/unclaim

Unclaim (release) specific items for a tab member

Unclaim items › path Parameters

tabId

string · uuid · required

UUID of the tab

Unclaim items › Request Body

tabMemberId

string · uuid · required

UUID of the tab member unclaiming the items

items

string[] · minItems: 1 · required

Array of item IDs to unclaim. In ITEM mode: inventory item UUIDs. In AMOUNT mode: virtual IDs like "split-index-0".

mode

string · enum

Payment mode: ITEM for individual item unclaiming, AMOUNT for split unclaiming

Enum values:

ITEM

AMOUNT

Unclaim items › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/{tabId}/items/unclaim

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/items/unclaim \
  --header 'Content-Type: application/json' \
  --data '
{
  "tabMemberId": "00000000-0000-0000-0000-000000000000",
  "items": [
    "string"
  ],
  "mode": "ITEM"
}
'

Example Request Body

{
  "tabMemberId": "00000000-0000-0000-0000-000000000000",
  "items": [
    "string"
  ],
  "mode": "ITEM"
}

Example Responses

No example specified for this content type

application/json

Unlock item selections

POST

https://common-api.karma.life

/api/v1/tabs/{tabId}/items/unlock

Unlock a tab member's selections (allows modifications again)

Unlock item selections › path Parameters

tabId

string · uuid · required

UUID of the tab

Unlock item selections › Request Body

UUID of the tab member to lock/unlock selections for (nullable)

clientId

string · uuid

UUID of the client (fallback identifier when tabMemberId is not available)

claimAfterUnlock

boolean

If true, freed items are re-claimed to the caller after force-unlock of another member.

skipCascadeCancel

boolean

When true, bypass the auto-cancel of any payment_in_progress settlements for the unlocked member. Use only for staff force-unlock flows. Default false.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: tabMemberId
	type = object · requires: clientId

Properties for Variant 1:

required

UUID of the tab member to lock/unlock selections for (nullable)

clientId

string · uuid

UUID of the client (fallback identifier when tabMemberId is not available)

claimAfterUnlock

boolean

If true, freed items are re-claimed to the caller after force-unlock of another member.

skipCascadeCancel

boolean

When true, bypass the auto-cancel of any payment_in_progress settlements for the unlocked member. Use only for staff force-unlock flows. Default false.

Unlock item selections › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/{tabId}/items/unlock

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/items/unlock \
  --header 'Content-Type: application/json' \
  --data '
{
  "tabMemberId": "00000000-0000-0000-0000-000000000000",
  "clientId": "00000000-0000-0000-0000-000000000000",
  "claimAfterUnlock": true,
  "skipCascadeCancel": true
}
'

Example Request Body

{
  "tabMemberId": "00000000-0000-0000-0000-000000000000",
  "clientId": "00000000-0000-0000-0000-000000000000",
  "claimAfterUnlock": true,
  "skipCascadeCancel": true
}

Example Responses

No example specified for this content type

application/json

Move dispatch to another table

POST

https://common-api.karma.life

/api/v1/tabs/{tabId}/move/dispatch

Move an entire kitchen_dispatch from a tab to another table

Move dispatch to another table › path Parameters

tabId

string · uuid · required

Source tab UUID

Move dispatch to another table › Request Body

dispatchId

string · uuid · required

Kitchen dispatch UUID to move

destinationTableId

string · uuid · required

Destination table (storefront_qr_code) UUID

Move dispatch to another table › Responses

Dispatch moved successfully

status

string · enum

Enum values:

success

object

POST/api/v1/tabs/{tabId}/move/dispatch

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/move/dispatch \
  --header 'Content-Type: application/json' \
  --data '
{
  "dispatchId": "00000000-0000-0000-0000-000000000000",
  "destinationTableId": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "dispatchId": "00000000-0000-0000-0000-000000000000",
  "destinationTableId": "00000000-0000-0000-0000-000000000000"
}

Example Responses

No example specified for this content type

application/json

Move items to another table

POST

https://common-api.karma.life

/api/v1/tabs/{tabId}/move/items

Move specific kitchen_dispatch_items from a tab to another table

Move items to another table › path Parameters

tabId

string · uuid · required

Source tab UUID

Move items to another table › Request Body

itemIds

string[] · minItems: 1 · required

Array of kitchen_dispatch_item UUIDs to move

destinationTableId

string · uuid · required

Destination table (storefront_qr_code) UUID

Move items to another table › Responses

Items moved successfully

status

string · enum

Enum values:

success

object

POST/api/v1/tabs/{tabId}/move/items

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/move/items \
  --header 'Content-Type: application/json' \
  --data '
{
  "itemIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "destinationTableId": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "itemIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "destinationTableId": "00000000-0000-0000-0000-000000000000"
}

Example Responses

No example specified for this content type

application/json

Move tab to another table

POST

https://common-api.karma.life

/api/v1/tabs/{tabId}/move/tab

Move an entire tab to another table. If destination table has an active tab, tabs are merged.

Move tab to another table › path Parameters

tabId

string · uuid · required

Source tab UUID

Move tab to another table › Request Body

destinationTableId

string · uuid · required

Destination table (storefront_qr_code) UUID

Move tab to another table › Responses

Tab moved or merged successfully

status

string · enum

Enum values:

success

object

POST/api/v1/tabs/{tabId}/move/tab

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/move/tab \
  --header 'Content-Type: application/json' \
  --data '
{
  "destinationTableId": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "destinationTableId": "00000000-0000-0000-0000-000000000000"
}

Example Responses

No example specified for this content type

application/json

Set payment split

POST

https://common-api.karma.life

/api/v1/tabs/{tabId}/payment-split

Set payment split for a tab (switches to AMOUNT mode).

This endpoint allows users to split the entire tab bill evenly among multiple people. When a split is set, the tab switches from ITEM mode to AMOUNT mode.

Constraints:

Split can only be set when no payments have been made yet
Split can be changed until someone locks items for checkout
Split value must be between 2 and 10
Tab must have items (total_amount_cents > 0)

Set payment split › path Parameters

tabId

string · uuid · required

The UUID of the tab

Set payment split › Request Body

payment_split

integer · min: 2 · max: 10 · required

Number of ways to split the tab (2-10)

Set payment split › Responses

Default Response

status

string · enum

Enum values:

success

object

POST/api/v1/tabs/{tabId}/payment-split

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/payment-split \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_split": 2
}
'

Example Request Body

{
  "payment_split": 2
}

Example Responses

No example specified for this content type

application/json

Clear payment split

DELETE

https://common-api.karma.life

/api/v1/tabs/{tabId}/payment-split

Clear payment split for a tab (reverts to ITEM mode).

This endpoint allows users to cancel/clear a previously set payment split. When cleared, the tab switches from AMOUNT mode back to ITEM mode.

Constraints:

Can only be cleared when no payments have been made yet
Cannot be cleared while items are locked for checkout
Tab must currently be in AMOUNT mode (split mode)

Use cases:

User changed their mind about splitting
Split was set by mistake
Group decided to pay individually instead

Clear payment split › path Parameters

tabId

string · uuid · required

The UUID of the tab

Clear payment split › Responses

Default Response

status

string · enum

Enum values:

success

object

DELETE/api/v1/tabs/{tabId}/payment-split

curl --request DELETE \
  --url https://common-api.karma.life/api/v1/tabs/:tabId/payment-split

Example Responses

No example specified for this content type

application/json

Get purchases for a tab

GET

https://common-api.karma.life

/api/v1/tabs/{tabId}/purchases

Get all confirmed purchases for a specific tab, including payer information and totals. Used to display payment history in the POS tab view.

Permissions: 🔵 purchases.read

Get purchases for a tab › path Parameters

tabId

string · uuid · required

Tab UUID

Get purchases for a tab › query Parameters

locationId

number · required

Location ID

Get purchases for a tab › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

GET/api/v1/tabs/{tabId}/purchases

curl --request GET \
  --url 'https://common-api.karma.life/api/v1/tabs/:tabId/purchases?locationId=%3Cnumber%3E'

Example Responses

No example specified for this content type

application/json

Check if tab exists for QR code (without joining)

POST

https://common-api.karma.life

/api/v1/tabs/check-exists

Checks if an active tab exists for a QR code WITHOUT joining the user to it. This is useful for instant-pay flows that want to show a "Join Tab" option but should not auto-join. Returns hasActiveTab: true/false with the tabId if one exists.

Permissions: 🔵 tabs.read

Check if tab exists for QR code (without joining) › Request Body

locationId

number · required

Restaurant location ID

qrCodeId

string · uuid · required

QR code UUID for the table

Check if tab exists for QR code (without joining) › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/check-exists

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/check-exists \
  --header 'Content-Type: application/json' \
  --data '
{
  "locationId": 0,
  "qrCodeId": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "locationId": 0,
  "qrCodeId": "00000000-0000-0000-0000-000000000000"
}

Example Responses

No example specified for this content type

application/json

Debug: recent tabs

GET

https://common-api.karma.life

/api/v1/tabs/debug/recent

Debug endpoint that returns recent tabs with balance verification, item allocations, and purchase breakdowns. Useful for diagnosing tab balance discrepancies.

Permissions: 🔵 tabs.read

Debug: recent tabs › query Parameters

limit

number · min: 1 · max: 20

Number of recent tabs to return (max 20)

Default: 5

locationId

number

Filter by location ID

Debug: recent tabs › Responses

Debug info for recent tabs

status

string · enum

Enum values:

success

object

GET/api/v1/tabs/debug/recent

curl --request GET \
  --url https://common-api.karma.life/api/v1/tabs/debug/recent

Example Responses

No example specified for this content type

application/json

Join existing tab for QR code

POST

https://common-api.karma.life

/api/v1/tabs/join-if-existing

Returns all active joinable tabs (≤7 days old) for the QR code. When exactly one tab exists, auto-joins the user. When multiple tabs exist, returns the list for user selection without joining (pass tabId in a second request to join a specific tab). Returns hasActiveTab:false if no active tabs exist.

Permissions: 🔵 tabs.read

Join existing tab for QR code › Request Body

locationId

number · required

Restaurant location ID

qrCodeId

string · uuid · required

QR code UUID for the table

object · required

User identification using priority system

tabId

string · uuid

Specific tab UUID to join (when user selects from multiple joinable tabs). Omit to auto-join or get the list.

Join existing tab for QR code › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/join-if-existing

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/join-if-existing \
  --header 'Content-Type: application/json' \
  --data '
{
  "locationId": 0,
  "qrCodeId": "00000000-0000-0000-0000-000000000000",
  "tabMember": {
    "id": 0,
    "email": "test@example.com",
    "phone": "phone",
    "identifier": "identifier"
  },
  "tabId": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "locationId": 0,
  "qrCodeId": "00000000-0000-0000-0000-000000000000",
  "tabMember": {
    "id": 0,
    "email": "test@example.com",
    "phone": "phone",
    "identifier": "identifier"
  },
  "tabId": "00000000-0000-0000-0000-000000000000"
}

Example Responses

No example specified for this content type

application/json

List the authenticated guest's active tabs

GET

https://common-api.karma.life

/api/v1/tabs/mine

Returns all non-terminal tabs (latest_state NOT IN closed/settled/aborted) where the Bearer-authenticated guest user is a tab_member. Includes members and a minimal location stub. Identity resolves via the same JWT path as buyer endpoints (HS256 mobile or OIDC RS256 storefront).

List the authenticated guest's active tabs › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

GET/api/v1/tabs/mine

curl --request GET \
  --url https://common-api.karma.life/api/v1/tabs/mine

Example Responses

No example specified for this content type

application/json

Get a single tab the authenticated guest is a member of

GET

https://common-api.karma.life

/api/v1/tabs/mine/{id}

Returns the same tab shape as GET /tabs/:id (members + items + location stub) but gated on tab_members.user_id matching the Bearer-authenticated guest. Returns 404 when the user is not a member of the tab.

Get a single tab the authenticated guest is a member of › path Parameters

id

string · uuid · required

Tab UUID

Get a single tab the authenticated guest is a member of › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

GET/api/v1/tabs/mine/{id}

curl --request GET \
  --url https://common-api.karma.life/api/v1/tabs/mine/:id

Example Responses

No example specified for this content type

application/json

Reconnect orphaned Adyen payment

POST

https://common-api.karma.life

/api/v1/tabs/reconnect-payment

Reconnect a payment that was authorized in Adyen but not recorded in Karma (due to terminal timeout). Creates a new purchase using the existing Adyen PSP reference. Karmeleon-only.

Permissions: 🟠 tabs.update

Reconnect orphaned Adyen payment › Request Body

tab_id

string · uuid · required

UUID of the tab to reconnect payment for

psp_reference

string · required

Adyen PSP reference from the orphaned authorization

terminal_id

string · uuid

Terminal ID (optional, for audit trail)

amount_cents

number · min: 1

Amount in cents (optional, defaults to remaining balance)

Reconnect orphaned Adyen payment › Responses

Payment reconnected successfully

status

string · enum

Enum values:

success

object

meta

object

POST/api/v1/tabs/reconnect-payment

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/reconnect-payment \
  --header 'Content-Type: application/json' \
  --data '
{
  "tab_id": "00000000-0000-0000-0000-000000000000",
  "psp_reference": "psp_reference",
  "terminal_id": "00000000-0000-0000-0000-000000000000",
  "amount_cents": 1
}
'

Example Request Body

{
  "tab_id": "00000000-0000-0000-0000-000000000000",
  "psp_reference": "psp_reference",
  "terminal_id": "00000000-0000-0000-0000-000000000000",
  "amount_cents": 1
}

Example Responses

No example specified for this content type

application/json

Resolve tab for user

POST

https://common-api.karma.life

/api/v1/tabs/resolve

Find existing tab or create new tab for a user. Handles QR code tables, user resolution with priority system (id > email > phone > identifier), tab member management, and order channel routing. Perfect for storefront integration before item commits.

Permissions: 🟢 tabs.create

Resolve tab for user › Request Body

locationId

number · required

Location ID for the tab

qrCodeId

string | null · required

QR code UUID (for table orders)

tabType

string · enum · required

Type of tab to create

Enum values:

table

takeaway

over_the_counter

paymentFlow

string · enum · required

Payment timing (open_tab = pay later, pay_upfront = pay now)

Enum values:

open_tab

pay_upfront

orderChannel

string · enum · required

Order channel (ONLINE = web interface, QR = QR code scan, KIOSK = self-service, POS = point of sale)

Enum values:

ONLINE

KIOSK

POS

object · required

User identification with priority-based resolution: id > email > phone > identifier

Resolve tab for user › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/tabs/resolve

curl --request POST \
  --url https://common-api.karma.life/api/v1/tabs/resolve \
  --header 'Content-Type: application/json' \
  --data '
{
  "locationId": 0,
  "qrCodeId": "qrCodeId",
  "tabType": "table",
  "paymentFlow": "open_tab",
  "orderChannel": "ONLINE",
  "tabMember": {
    "id": 0,
    "email": "test@example.com",
    "phone": "phone",
    "identifier": "identifier",
    "language": "language"
  }
}
'

Example Request Body

{
  "locationId": 0,
  "qrCodeId": "qrCodeId",
  "tabType": "table",
  "paymentFlow": "open_tab",
  "orderChannel": "ONLINE",
  "tabMember": {
    "id": 0,
    "email": "test@example.com",
    "phone": "phone",
    "identifier": "identifier",
    "language": "language"
  }
}

Example Responses

No example specified for this content type

application/json

Webhook: Tab opened

POST

https://common-api.karma.life

/webhook/tab.opened

Fired when a new tab is created (e.g. POST /api/v1/tabs/resolve, or table seating).

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: Tab opened › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.opened

resource

string · enum · required

Enum values:

tab

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: Tab opened › Responses

200

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

No data returned

POST/webhook/tab.opened

curl --request POST \
  --url https://common-api.karma.life/webhook/tab.opened \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "tab.opened",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "tabType": "tabType",
    "paymentFlow": "open_tab",
    "qrCodeId": "qrCodeId",
    "tableId": "tableId",
    "createdBy": 0,
    "costCenterId": 0,
    "createdAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.opened",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "tabType": "tabType",
    "paymentFlow": "open_tab",
    "qrCodeId": "qrCodeId",
    "tableId": "tableId",
    "createdBy": 0,
    "costCenterId": 0,
    "createdAt": "2024-08-25T15:00:00Z"
  }
}

Example Responses

No example specified for this content type

Webhook: Tab updated

POST

https://common-api.karma.life

/webhook/tab.updated

Fired on any tab modification: items added, payments received, balance updated, etc. changes describes what shifted.

Webhook: Tab updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.updated

resource

string · enum · required

Enum values:

tab

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: Tab updated › Responses

200

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

No data returned

POST/webhook/tab.updated

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

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.updated",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "tableId": "tableId",
    "costCenterId": 0,
    "tabType": "tabType",
    "changes": {},
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

Example Responses

No example specified for this content type

Webhook: Tab closed

POST

https://common-api.karma.life

/webhook/tab.closed

Fired when a tab is settled or abandoned. Carries the final total and a state describing why it closed.

Webhook: Tab closed › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.closed

resource

string · enum · required

Enum values:

tab

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: Tab closed › Responses

200

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

No data returned

POST/webhook/tab.closed

curl --request POST \
  --url https://common-api.karma.life/webhook/tab.closed \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "tab.closed",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "tableId": "tableId",
    "costCenterId": 0,
    "totalAmount": 0,
    "state": "state",
    "reason": "reason",
    "closedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.closed",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "tableId": "tableId",
    "costCenterId": 0,
    "totalAmount": 0,
    "state": "state",
    "reason": "reason",
    "closedAt": "2024-08-25T15:00:00Z"
  }
}

Example Responses

No example specified for this content type

Webhook: Tab member added

POST

https://common-api.karma.life

/webhook/tab.member_added

Fired when a guest joins an existing tab (POST /api/v1/tabs/:id/members).

Webhook: Tab member added › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.member_added

resource

string · enum · required

Enum values:

tab

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: Tab member added › Responses

200

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

No data returned

POST/webhook/tab.member_added

curl --request POST \
  --url https://common-api.karma.life/webhook/tab.member_added \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "tab.member_added",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabMemberId": "00000000-0000-0000-0000-000000000000",
    "userId": 0,
    "isNewUser": true,
    "memberType": "GUEST",
    "addedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.member_added",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabMemberId": "00000000-0000-0000-0000-000000000000",
    "userId": 0,
    "isNewUser": true,
    "memberType": "GUEST",
    "addedAt": "2024-08-25T15:00:00Z"
  }
}

Example Responses

No example specified for this content type

Webhook: Tab payment initiated

POST

https://common-api.karma.life

/webhook/tab.payment_initiated

Fired when a payment is initiated (POST /api/v1/tabs/:id/pay). Mode-specific fields (itemCount, itemIds) are present only for ITEM mode.

Webhook: Tab payment initiated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.payment_initiated

resource

string · enum · required

Enum values:

tab

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: Tab payment initiated › Responses

200

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

No data returned

POST/webhook/tab.payment_initiated

curl --request POST \
  --url https://common-api.karma.life/webhook/tab.payment_initiated \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "tab.payment_initiated",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabSettlementId": "00000000-0000-0000-0000-000000000000",
    "purchaseIntentId": "00000000-0000-0000-0000-000000000000",
    "paymentMethod": "prepaid",
    "paymentMode": "ITEM",
    "amountCents": 0,
    "itemCount": 0,
    "itemIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "initiatedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.payment_initiated",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabSettlementId": "00000000-0000-0000-0000-000000000000",
    "purchaseIntentId": "00000000-0000-0000-0000-000000000000",
    "paymentMethod": "prepaid",
    "paymentMode": "ITEM",
    "amountCents": 0,
    "itemCount": 0,
    "itemIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "initiatedAt": "2024-08-25T15:00:00Z"
  }
}

Example Responses

No example specified for this content type

Webhook: Tab payment progress (terminal)

POST

https://common-api.karma.life

/webhook/tab.payment_progress

UI hint emitted as Adyen terminal reports stages (card insertion, PIN, approved, etc.). Fire-and-forget — NOT authoritative; POS waits for tab.payment_completed/failed. Duplicates and out-of-order events are tolerated.

Webhook: Tab payment progress (terminal) › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.payment_progress

resource

string · enum · required

Enum values:

tab

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: Tab payment progress (terminal) › Responses

200

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

No data returned

POST/webhook/tab.payment_progress

curl --request POST \
  --url https://common-api.karma.life/webhook/tab.payment_progress \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "tab.payment_progress",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabSettlementId": "00000000-0000-0000-0000-000000000000",
    "purchaseIntentId": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "stage": "awaiting_card",
    "poiId": "poiId",
    "saleId": "saleId",
    "rawEventAt": "2024-08-25T15:00:00Z",
    "emittedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.payment_progress",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabSettlementId": "00000000-0000-0000-0000-000000000000",
    "purchaseIntentId": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "stage": "awaiting_card",
    "poiId": "poiId",
    "saleId": "saleId",
    "rawEventAt": "2024-08-25T15:00:00Z",
    "emittedAt": "2024-08-25T15:00:00Z"
  }
}

Example Responses

No example specified for this content type

Webhook: Tab payment completed

POST

https://common-api.karma.life

/webhook/tab.payment_completed

Authoritative success signal for a tab payment. Includes the PSP reference for reconciliation.

Webhook: Tab payment completed › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.payment_completed

resource

string · enum · required

Enum values:

tab

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: Tab payment completed › Responses

200

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

No data returned

POST/webhook/tab.payment_completed

curl --request POST \
  --url https://common-api.karma.life/webhook/tab.payment_completed \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "tab.payment_completed",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabSettlementId": "00000000-0000-0000-0000-000000000000",
    "purchaseIntentId": "00000000-0000-0000-0000-000000000000",
    "paymentMethod": "prepaid",
    "paymentMode": "ITEM",
    "amountCents": 0,
    "pspReference": "pspReference",
    "itemIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "completedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.payment_completed",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabSettlementId": "00000000-0000-0000-0000-000000000000",
    "purchaseIntentId": "00000000-0000-0000-0000-000000000000",
    "paymentMethod": "prepaid",
    "paymentMode": "ITEM",
    "amountCents": 0,
    "pspReference": "pspReference",
    "itemIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "completedAt": "2024-08-25T15:00:00Z"
  }
}

Example Responses

No example specified for this content type

Webhook: Tab payment failed

POST

https://common-api.karma.life

/webhook/tab.payment_failed

Authoritative failure signal for a tab payment. Includes error code and message for debugging.

Webhook: Tab payment failed › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.payment_failed

resource

string · enum · required

Enum values:

tab

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: Tab payment failed › Responses

200

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

No data returned

POST/webhook/tab.payment_failed

curl --request POST \
  --url https://common-api.karma.life/webhook/tab.payment_failed \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "tab.payment_failed",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabSettlementId": "00000000-0000-0000-0000-000000000000",
    "purchaseIntentId": "00000000-0000-0000-0000-000000000000",
    "paymentMethod": "prepaid",
    "paymentMode": "ITEM",
    "amountCents": 0,
    "errorCode": "errorCode",
    "errorMessage": "errorMessage",
    "itemIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "failedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.payment_failed",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabSettlementId": "00000000-0000-0000-0000-000000000000",
    "purchaseIntentId": "00000000-0000-0000-0000-000000000000",
    "paymentMethod": "prepaid",
    "paymentMode": "ITEM",
    "amountCents": 0,
    "errorCode": "errorCode",
    "errorMessage": "errorMessage",
    "itemIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "failedAt": "2024-08-25T15:00:00Z"
  }
}

Example Responses

No example specified for this content type

Webhook: Tab items claimed by member

POST

https://common-api.karma.life

/webhook/tab.item.claimed

Fired when a tab member claims items for payment. clientId correlates to the browser session that initiated the claim.

Webhook: Tab items claimed by member › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.item.claimed

resource

string · enum · required

Enum values:

tab

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: Tab items claimed by member › Responses

200

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

No data returned

POST/webhook/tab.item.claimed

curl --request POST \
  --url https://common-api.karma.life/webhook/tab.item.claimed \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "tab.item.claimed",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabMemberId": "00000000-0000-0000-0000-000000000000",
    "clientId": "clientId",
    "claimedItems": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "claimedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.item.claimed",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabMemberId": "00000000-0000-0000-0000-000000000000",
    "clientId": "clientId",
    "claimedItems": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "claimedAt": "2024-08-25T15:00:00Z"
  }
}

Example Responses

No example specified for this content type

Webhook: Tab items released by member

POST

https://common-api.karma.life

/webhook/tab.item.unclaimed

Fired when a tab member unclaims items.

Webhook: Tab items released by member › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.item.unclaimed

resource

string · enum · required

Enum values:

tab

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: Tab items released by member › Responses

200

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

No data returned

POST/webhook/tab.item.unclaimed

curl --request POST \
  --url https://common-api.karma.life/webhook/tab.item.unclaimed \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "tab.item.unclaimed",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabMemberId": "00000000-0000-0000-0000-000000000000",
    "clientId": "clientId",
    "unclaimedItems": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "unclaimedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.item.unclaimed",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabMemberId": "00000000-0000-0000-0000-000000000000",
    "clientId": "clientId",
    "unclaimedItems": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "unclaimedAt": "2024-08-25T15:00:00Z"
  }
}

Example Responses

No example specified for this content type

Webhook: Tab member item selection changed

POST

https://common-api.karma.life

/webhook/tab.items.updated

Single event covering any combination of claims and unclaims in one operation. Note: timestamp field is at, not updatedAt.

Webhook: Tab member item selection changed › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.items.updated

resource

string · enum · required

Enum values:

tab

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: Tab member item selection changed › Responses

200

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

No data returned

POST/webhook/tab.items.updated

curl --request POST \
  --url https://common-api.karma.life/webhook/tab.items.updated \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "tab.items.updated",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabMemberId": "00000000-0000-0000-0000-000000000000",
    "clientId": "clientId",
    "claimedItems": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "unclaimedItems": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "at": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.items.updated",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabMemberId": "00000000-0000-0000-0000-000000000000",
    "clientId": "clientId",
    "claimedItems": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "unclaimedItems": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "at": "2024-08-25T15:00:00Z"
  }
}

Example Responses

No example specified for this content type

Webhook: Tab member items locked for checkout

POST

https://common-api.karma.life

/webhook/tab.items.locked

Fired when a member's claimed items are locked for the payment flow.

Webhook: Tab member items locked for checkout › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.items.locked

resource

string · enum · required

Enum values:

tab

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: Tab member items locked for checkout › Responses

200

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

No data returned

POST/webhook/tab.items.locked

curl --request POST \
  --url https://common-api.karma.life/webhook/tab.items.locked \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "tab.items.locked",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabMemberId": "00000000-0000-0000-0000-000000000000",
    "clientId": "clientId",
    "lockedItems": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "lockedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.items.locked",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabMemberId": "00000000-0000-0000-0000-000000000000",
    "clientId": "clientId",
    "lockedItems": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "lockedAt": "2024-08-25T15:00:00Z"
  }
}

Example Responses

No example specified for this content type

Webhook: Tab member items unlocked

POST

https://common-api.karma.life

/webhook/tab.items.unlocked

Fired when locked items are released (e.g. cancelled checkout). cancelledByClientId records who cancelled.

Webhook: Tab member items unlocked › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

tab.items.unlocked

resource

string · enum · required

Enum values:

tab

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: Tab member items unlocked › Responses

200

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

No data returned

POST/webhook/tab.items.unlocked

curl --request POST \
  --url https://common-api.karma.life/webhook/tab.items.unlocked \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "tab.items.unlocked",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabMemberId": "00000000-0000-0000-0000-000000000000",
    "clientId": "clientId",
    "unlockedItems": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "unlockedAt": "2024-08-25T15:00:00Z",
    "cancelledByClientId": "cancelledByClientId"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "tab.items.unlocked",
  "resource": "tab",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "tabId": "00000000-0000-0000-0000-000000000000",
    "tabMemberId": "00000000-0000-0000-0000-000000000000",
    "clientId": "clientId",
    "unlockedItems": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "locationId": 0,
    "unlockedAt": "2024-08-25T15:00:00Z",
    "cancelledByClientId": "cancelledByClientId"
  }
}

Example Responses

No example specified for this content type

Tables Terminals