CWI

Server

Download schema

Company-Wide Items (CWI) management via EAN

List CWI items for company

GET

https://common-api.karma.life

/api/v1/cwi/items

List all CWI items (items with EAN) for the authenticated company.

Supports pagination and optional filtering by location.

Permissions: 🔵 cwi.read

List CWI items for company › query Parameters

page

number · min: 1

Page number

Default: 1

limit

number · min: 1 · max: 100

Items per page

Default: 50

locationId

number

Filter by location ID

List CWI items for company › Responses

List of CWI items

status

string · enum · required

Enum values:

success

object · required

Create or update a CWI item by EAN

PUT

https://common-api.karma.life

/api/v1/cwi/items

Create or update a CWI item by EAN.

If an item with the given EAN already exists for the company, it is updated. Otherwise, a new item is created. Returns 201 for creation, 200 for update.

Discount validation: Must be between 50 and 90, and must end in 0 or 5 (e.g. 50, 55, 60, 65, 70, 75, 80, 85, 90).

Allergen codes: Use two-letter codes (e.g. AW = Gluten, AE = Egg, AM = Milk). See the allergenCodes field for the full list.

Permissions: ⚪ cwi.write

Create or update a CWI item by EAN › Request Body

ean

string · required

EAN / article number (unique per company)

Example: 7310070771223

title

string · required

Item title

Example: Sourdough Bread

fullPrice

number · required

Full price in cents (e.g. 5900 = 59 SEK)

Example: 5900

discount

number · min: 50 · max: 90 · required

Discount percentage (50-90, must end in 0 or 5)

Example: 50

description

string

Item description

Example: Freshly baked sourdough bread

category

string · enum

Item category

Enum values:

DRINK

GROCERY

FULL_MEAL

BREAD

SWEETS

SNACK

preferences

string[]

Dietary preferences

Enum values:

GLUTEN_FREE

PORK

BEEF

CHICKEN

VEGAN

VEGETARIAN

FISH_PREF

SHELLFISH_PREF

allergenCodes

string[]

Allergen codes. Common codes: AW=Gluten, AE=Egg, AF=Fish, AM=Milk, AN=Nuts, AP=Peanuts, AY=Soya, UW=Wheat

Enum values:

Create or update a CWI item by EAN › Responses

Item updated successfully

status

string · enum · required

Enum values:

success

object · required

PUT/api/v1/cwi/items

curl --request PUT \
  --url https://common-api.karma.life/api/v1/cwi/items \
  --header 'Content-Type: application/json' \
  --data '
{
  "ean": "7310070771223",
  "title": "Sourdough Bread",
  "fullPrice": 5900,
  "discount": 50,
  "description": "Freshly baked sourdough bread",
  "category": "DRINK",
  "preferences": [
    "GLUTEN_FREE"
  ],
  "allergenCodes": [
    "AC"
  ]
}
'

Example Request Body

{
  "ean": "7310070771223",
  "title": "Sourdough Bread",
  "fullPrice": 5900,
  "discount": 50,
  "description": "Freshly baked sourdough bread",
  "category": "DRINK",
  "preferences": [
    "GLUTEN_FREE"
  ],
  "allergenCodes": [
    "AC"
  ]
}

json

Example Responses

No example specified for this content type

application/json

Delete a CWI item by EAN

DELETE

https://common-api.karma.life

/api/v1/cwi/items/{ean}

Soft-delete a CWI item by EAN.

Marks the item as deleted. The item can no longer be found via the list endpoint.

Permissions: 🔴 cwi.delete

Delete a CWI item by EAN › path Parameters

ean

string · required

EAN / article number of the item to delete

Delete a CWI item by EAN › Responses

Item deleted successfully

status

string · enum · required

Enum values:

success

object · required

Custom Tags Data Streaming

List CWI items for company

GET

https://common-api.karma.life

/api/v1/cwi/items

List all CWI items (items with EAN) for the authenticated company.

Supports pagination and optional filtering by location.

Permissions: 🔵 cwi.read

List CWI items for company › query Parameters

page

number · min: 1

Page number

Default: 1

limit

number · min: 1 · max: 100

Items per page

Default: 50

locationId

number

Filter by location ID

List CWI items for company › Responses

List of CWI items

status

string · enum · required

Enum values:

success

object · required

Create or update a CWI item by EAN

PUT

https://common-api.karma.life

/api/v1/cwi/items

Create or update a CWI item by EAN.

If an item with the given EAN already exists for the company, it is updated. Otherwise, a new item is created. Returns 201 for creation, 200 for update.

Discount validation: Must be between 50 and 90, and must end in 0 or 5 (e.g. 50, 55, 60, 65, 70, 75, 80, 85, 90).

Allergen codes: Use two-letter codes (e.g. AW = Gluten, AE = Egg, AM = Milk). See the allergenCodes field for the full list.

Permissions: ⚪ cwi.write

Create or update a CWI item by EAN › Request Body

ean

string · required

EAN / article number (unique per company)

Example: 7310070771223

title

string · required

Item title

Example: Sourdough Bread

fullPrice

number · required

Full price in cents (e.g. 5900 = 59 SEK)

Example: 5900

discount

number · min: 50 · max: 90 · required

Discount percentage (50-90, must end in 0 or 5)

Example: 50

description

string

Item description

Example: Freshly baked sourdough bread

category

string · enum

Item category

Enum values:

DRINK

GROCERY

FULL_MEAL

BREAD

SWEETS

SNACK

preferences

string[]

Dietary preferences

Enum values:

GLUTEN_FREE

PORK

BEEF

CHICKEN

VEGAN

VEGETARIAN

FISH_PREF

SHELLFISH_PREF

allergenCodes

string[]

Allergen codes. Common codes: AW=Gluten, AE=Egg, AF=Fish, AM=Milk, AN=Nuts, AP=Peanuts, AY=Soya, UW=Wheat

Enum values:

Create or update a CWI item by EAN › Responses

Item updated successfully

status

string · enum · required

Enum values:

success

object · required

Delete a CWI item by EAN

DELETE

https://common-api.karma.life

/api/v1/cwi/items/{ean}

Soft-delete a CWI item by EAN.

Marks the item as deleted. The item can no longer be found via the list endpoint.

Permissions: 🔴 cwi.delete

Delete a CWI item by EAN › path Parameters

ean

string · required

EAN / article number of the item to delete

Delete a CWI item by EAN › Responses

Item deleted successfully

status

string · enum · required

Enum values:

success

object · required