Skip to content

Products

The Products entity represents the catalog of items available in the system.

Fields

FieldTypeDescription
idIntegerUnique identifier (Primary Key).
nameStringProduct name.
barcodeStringProduct barcode.
typeEnumProduct type (e.g., product, beverage, set, accessory).
categoryRelationRelation to ProductCategories.
priceFloatSelling price.
entryPriceFloatPurchase/Entry price.
weightIntegerProduct weight.
unitEnumMeasurement unit (e.g., kg, pcs, unit).
imageFileProduct image reference.
externalIdStringExternal system reference.
countryOfOriginRelationCountry of origin. Relation to Countries.
importedBooleanWhether the product is imported.
exciseBooleanWhether the product is subject to excise tax.
uktzedStringUKTZED code (for fiscal documents).
milkBeverageBooleanFlag for milk-based beverages.
createdAtDateTimeCreation timestamp.
updatedAtDateTimeLast update timestamp.

Get List of Products

Endpoint: POST /core/data/Products/select

Example Request:

json
{
  "fields": {
    "id": true,
    "name": true,
    "barcode": true,
    "price": true,
    "category": { "id": true, "name": true }
  },
  "conditions": {
    "operator": "and",
    "filters": [
      {
        "field": "category.id",
        "comparator": "=",
        "value": 10
      }
    ]
  },
  "orderBy": [
    {
      "field": "name",
      "order": "asc"
    }
  ],
  "limit": 50,
  "offset": 0
}

Get Single Product

Endpoint: POST /core/data/Products/select

Example Request:

json
{
  "fields": {
    "id": true,
    "name": true,
    "barcode": true,
    "price": true,
    "type": { "id": true, "value": true }
  },
  "conditions": {
    "filters": [
      {
        "field": "id",
        "comparator": "=",
        "value": 501
      }
    ]
  },
  "limit": 1
}

Create Product

Endpoint: POST /core/data/Products/insert

Example Request:

json
{
  "fields": [
    {
      "name": "Sparkling Water 0.5L",
      "barcode": "5901234567890",
      "price": 2500,
      "category": { "id": 10 },
      "type": { "id": 1 }
    }
  ]
}

Update Product

Endpoint: POST /core/data/Products/update/{id}

Example Request:

json
{
  "fields": {
    "price": 2750,
    "excise": true
  }
}

Delete Products

Endpoint: POST /core/data/Products/remove

Example Request:

json
{
  "conditions": {
    "operator": "and",
    "filters": [
      {
        "field": "id",
        "comparator": "in",
        "value": [501, 502]
      }
    ]
  }
}