Skip to content

Stock Replenishments

The StockReplenishments entity represents the process of refilling product stock in a device or kiosk.

Fields

FieldTypeDescription
idIntegerUnique identifier (Primary Key).
numberStringReplenishment document number.
dateDateTimeDate and time of the operation.
typeEnumType of replenishment operation (itemReplenishment, accessoryReplenishment, testReplenishment).
conveniqRelationThe device where the replenishment took place.
userRelationThe user (staff) who performed the operation.
frontalPhotosFile[]Collection of photos taken during replenishment.
createdAtDateTimeMetadata: Creation timestamp.
updatedAtDateTimeMetadata: Last update timestamp.

Get List of Replenishments

Fetch a list of stock replenishment operations.

Endpoint: POST /core/data/StockReplenishments/select

Example Request:

json
{
  "fields": {
    "id": true,
    "number": true,
    "date": true,
    "type": { "id": true, "value": true },
    "conveniq": { "id": true, "name": true }
  },
  "conditions": {
    "operator": "and",
    "filters": [
      {
        "field": "date",
        "comparator": ">",
        "value": "2025-01-01T00:00:00Z"
      }
    ]
  },
  "orderBy": [
    {
      "field": "date",
      "order": "desc"
    }
  ],
  "limit": 50,
  "offset": 0
}

Get Single Replenishment

Retrieve details for a specific replenishment by ID.

Endpoint: POST /core/data/StockReplenishments/select

Example Request:

json
{
  "fields": {
    "id": true,
    "number": true,
    "date": true,
    "user": { "id": true, "name": true },
    "frontalPhotos": { "id": true, "fileName": true }
  },
  "conditions": {
    "filters": [
      {
        "field": "id",
        "comparator": "=",
        "value": 3001
      }
    ]
  },
  "limit": 1
}

Replenishment Products (Table Part)

The StockReplenishmentsProducts entity stores individual items added during a replenishment.

Table Part Fields

FieldTypeDescription
idIntegerUnique identifier.
ownerRelationLink to the parent StockReplenishments document.
productRelationLink to the Products entity.
quantityFloatQuantity added to the stock.
priceFloatUnit price at the time of replenishment.
createdAtDateTimeMetadata: Creation timestamp.
updatedAtDateTimeMetadata: Last update timestamp.

Get Products for a Replenishment

To fetch all products for a specific replenishment, filter by the owner.id field.

Endpoint: POST /core/data/StockReplenishmentsProducts/select

Example Request:

json
{
  "fields": {
    "id": true,
    "product": { "id": true, "name": true },
    "quantity": true,
    "price": true
  },
  "conditions": {
    "operator": "and",
    "filters": [
      {
        "field": "owner.id",
        "comparator": "=",
        "value": 3001
      }
    ]
  },
  "limit": 500
}