InventoryMod API

List products

List products, optionally filtered by category, manufacturer, currency or kind. Variant parents (models) are excluded by default; pass includeParents: true to include them.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "sku": "ABC-1",
      "barcode": "CODE",
      "name": "Sample",
      "manufacturerId": 1,
      "categoryId": 1,
      "price": 9.99,
      "priceOld": 9.99,
      "rrp": 9.99,
      "currencyId": 1,
      "purchaseCost": 9.99,
      "purchaseCostCurrencyId": 1,
      "url": "string",
      "imageUrl": "string",
      "minQty": 9.99,
      "customFieldValues": {},
      "isArchived": false,
      "kind": "simple",
      "laborCost": 9.99,
      "laborCostCurrencyId": 1,
      "componentsUpdatedAt": "2026-01-01T00:00:00.000Z",
      "parentId": 1,
      "variantKey": "string",
      "nameLocked": false,
      "createdAtUtc": "2026-01-01T00:00:00.000Z",
      "updatedAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Search products

Paginated product list with filters, search, stock status and sorting, plus the total count.

{
  "data": {
    "items": [
      {
        "id": 1,
        "campaignId": 1,
        "sku": "ABC-1",
        "barcode": "CODE",
        "name": "Sample",
        "manufacturerId": 1,
        "categoryId": 1,
        "price": 9.99,
        "priceOld": 9.99,
        "rrp": 9.99,
        "currencyId": 1,
        "purchaseCost": 9.99,
        "purchaseCostCurrencyId": 1,
        "url": "string",
        "imageUrl": "string",
        "minQty": 9.99,
        "customFieldValues": {},
        "isArchived": false,
        "kind": "simple",
        "laborCost": 9.99,
        "laborCostCurrencyId": 1,
        "componentsUpdatedAt": "2026-01-01T00:00:00.000Z",
        "parentId": 1,
        "variantKey": "string",
        "nameLocked": false,
        "createdAtUtc": "2026-01-01T00:00:00.000Z",
        "updatedAtUtc": "2026-01-01T00:00:00.000Z"
      }
    ],
    "totalCount": 1
  }
}

Change product kind

Change the product kind. This is the only way to change the kind of an existing product.

{
  "opts": {}
}

{
  "data": {}
}

Get kind change facts

Facts about a product that determine which kind changes are allowed.

{
  "data": {}
}

Export products

Export products in batches using keyset pagination (id > afterId). Includes archived products, ordered by id.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "sku": "ABC-1",
      "barcode": "CODE",
      "name": "Sample",
      "manufacturerId": 1,
      "categoryId": 1,
      "price": 9.99,
      "priceOld": 9.99,
      "rrp": 9.99,
      "currencyId": 1,
      "purchaseCost": 9.99,
      "purchaseCostCurrencyId": 1,
      "url": "string",
      "imageUrl": "string",
      "minQty": 9.99,
      "customFieldValues": {},
      "isArchived": false,
      "kind": "simple",
      "laborCost": 9.99,
      "laborCostCurrencyId": 1,
      "componentsUpdatedAt": "2026-01-01T00:00:00.000Z",
      "parentId": 1,
      "variantKey": "string",
      "nameLocked": false,
      "createdAtUtc": "2026-01-01T00:00:00.000Z",
      "updatedAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Get product info for an order line

Price, currency and available stock per warehouse for an order line. For a kit, also returns its computed stock and components.

{
  "data": {}
}

Get a product

Get a product by id.

{
  "data": {
    "id": 1,
    "campaignId": 1,
    "sku": "ABC-1",
    "barcode": "CODE",
    "name": "Sample",
    "manufacturerId": 1,
    "categoryId": 1,
    "price": 9.99,
    "priceOld": 9.99,
    "rrp": 9.99,
    "currencyId": 1,
    "purchaseCost": 9.99,
    "purchaseCostCurrencyId": 1,
    "url": "string",
    "imageUrl": "string",
    "minQty": 9.99,
    "customFieldValues": {},
    "isArchived": false,
    "kind": "simple",
    "laborCost": 9.99,
    "laborCostCurrencyId": 1,
    "componentsUpdatedAt": "2026-01-01T00:00:00.000Z",
    "parentId": 1,
    "variantKey": "string",
    "nameLocked": false,
    "createdAtUtc": "2026-01-01T00:00:00.000Z",
    "updatedAtUtc": "2026-01-01T00:00:00.000Z"
  }
}

Find a product by SKU

Find a product by SKU.

{
  "data": {
    "id": 1,
    "campaignId": 1,
    "sku": "ABC-1",
    "barcode": "CODE",
    "name": "Sample",
    "manufacturerId": 1,
    "categoryId": 1,
    "price": 9.99,
    "priceOld": 9.99,
    "rrp": 9.99,
    "currencyId": 1,
    "purchaseCost": 9.99,
    "purchaseCostCurrencyId": 1,
    "url": "string",
    "imageUrl": "string",
    "minQty": 9.99,
    "customFieldValues": {},
    "isArchived": false,
    "kind": "simple",
    "laborCost": 9.99,
    "laborCostCurrencyId": 1,
    "componentsUpdatedAt": "2026-01-01T00:00:00.000Z",
    "parentId": 1,
    "variantKey": "string",
    "nameLocked": false,
    "createdAtUtc": "2026-01-01T00:00:00.000Z",
    "updatedAtUtc": "2026-01-01T00:00:00.000Z"
  }
}

Find a product by SKU or barcode

Find a product by SKU or barcode.

{
  "data": {
    "id": 1,
    "campaignId": 1,
    "sku": "ABC-1",
    "barcode": "CODE",
    "name": "Sample",
    "manufacturerId": 1,
    "categoryId": 1,
    "price": 9.99,
    "priceOld": 9.99,
    "rrp": 9.99,
    "currencyId": 1,
    "purchaseCost": 9.99,
    "purchaseCostCurrencyId": 1,
    "url": "string",
    "imageUrl": "string",
    "minQty": 9.99,
    "customFieldValues": {},
    "isArchived": false,
    "kind": "simple",
    "laborCost": 9.99,
    "laborCostCurrencyId": 1,
    "componentsUpdatedAt": "2026-01-01T00:00:00.000Z",
    "parentId": 1,
    "variantKey": "string",
    "nameLocked": false,
    "createdAtUtc": "2026-01-01T00:00:00.000Z",
    "updatedAtUtc": "2026-01-01T00:00:00.000Z"
  }
}

Get price history

Price history of a product.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "productId": 1,
      "price": 9.99,
      "currencyId": 1,
      "createdAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create a product

Create a product. Returns its id.

{
  "product": {
    "sku": "ABC-1",
    "barcode": "CODE",
    "name": "Sample",
    "manufacturerId": 1,
    "categoryId": 1,
    "price": 9.99,
    "priceOld": 9.99,
    "rrp": 9.99,
    "currencyId": 1,
    "purchaseCost": 9.99,
    "purchaseCostCurrencyId": 1,
    "url": "string",
    "imageUrl": "string",
    "minQty": 9.99,
    "customFieldValues": {},
    "isArchived": false,
    "kind": "simple",
    "laborCost": 9.99,
    "laborCostCurrencyId": 1
  }
}

{
  "data": 1
}

Update a product

Update product fields. The kind field is ignored — use setProductKind.

{
  "patch": {
    "sku": "ABC-1",
    "barcode": "CODE",
    "name": "Sample",
    "manufacturerId": 1,
    "categoryId": 1,
    "price": 9.99,
    "priceOld": 9.99,
    "rrp": 9.99,
    "currencyId": 1,
    "purchaseCost": 9.99,
    "purchaseCostCurrencyId": 1,
    "url": "string",
    "imageUrl": "string",
    "minQty": 9.99,
    "customFieldValues": {},
    "isArchived": false,
    "kind": "simple",
    "laborCost": 9.99,
    "laborCostCurrencyId": 1
  }
}

{
  "data": null
}

Bulk update products

Apply the same changes to several products by id.

{
  "ids": {},
  "patch": {}
}

{
  "data": null
}

Create or update a product by SKU

Create a product, or update the existing one with the same SKU.

{
  "product": {
    "sku": "ABC-1",
    "barcode": "CODE",
    "name": "Sample",
    "manufacturerId": 1,
    "categoryId": 1,
    "price": 9.99,
    "priceOld": 9.99,
    "rrp": 9.99,
    "currencyId": 1,
    "purchaseCost": 9.99,
    "purchaseCostCurrencyId": 1,
    "url": "string",
    "imageUrl": "string",
    "minQty": 9.99,
    "customFieldValues": {},
    "isArchived": false,
    "kind": "simple",
    "laborCost": 9.99,
    "laborCostCurrencyId": 1
  }
}

{
  "data": 1
}

Get product references

Count everything that references a product (movements, orders, reservations, stock) — useful before deleting it.

{
  "data": {}
}

Delete a product

Delete a product. By default it fails if the product has movements, orders, reservations or stock — archive it instead. With cascade=true, all related records are deleted as well.

{
  "opts": {}
}

{
  "data": null
}

List components

Components of a product. warehouseId selects the warehouse(s) for the “available” column; without it, stock is summed across all warehouses.

{
  "data": []
}

Add or update a component

Add a component or update its quantity. The quantity must be positive, the component must be a stocked product, cycles are rejected, and the parent must be an assembled product or a kit.

{
  "input": {}
}

{
  "data": 1
}

Remove a component

Remove a component from a product.

{
  "data": {}
}

Reorder components

Reorder components. componentIds must contain exactly the current set of component ids.

{
  "componentIds": {}
}

{
  "data": null
}

Where a product is used

Products and kits that use this product as a component.

{
  "data": []
}

Products not allowed as components

Ids of products that cannot be added as components of productId (the product itself and its ancestors).

{
  "data": {}
}

Calculate assembly cost

Unit cost of an assembled product from current component purchase prices, plus labour cost.

{
  "data": {}
}

List option axes

Option axes of a model (e.g. Size, Color) with their values and the number of variants per value.

{
  "data": []
}

Create an option axis

Add an option axis to a model. If the model already has variants, defaultValue is required.

{
  "name": {},
  "input": {}
}

{
  "data": {}
}

Rename an option axis

Rename an option axis. Variant names are updated accordingly.

{
  "patch": {}
}

{
  "data": {}
}

Delete an option axis

Delete an option axis. Allowed when the model has no variants, or when variant combinations remain unique without it.

{
  "data": {}
}

Reorder option axes

Reorder option axes. This defines the order of values in variant names.

{
  "optionIds": {}
}

{
  "data": null
}

Add an option value

Add a value to an option axis. code is used in variant SKUs (transliterated from the value by default).

{
  "value": {},
  "code": {}
}

{
  "data": 1
}

Update an option value

Change an option value or its code. Affected variant names are updated.

{
  "patch": {}
}

{
  "data": {}
}

Delete an option value

Delete an option value. Allowed only if no variant uses it.

{
  "data": null
}

Reorder option values

Reorder the values of an option axis.

{
  "valueIds": {}
}

{
  "data": null
}

List variants

Variants of one or more models, with their option values and stock.

{
  "data": []
}

Generate variants

Generate variants for all combinations of option values. Fields are copied from the model, names and SKUs are built automatically (-2, -3 suffixes on collision). Existing combinations are skipped and reported.

{
  "input": {}
}

{
  "data": {}
}

Change variant option values

Change the option values of an existing variant. The new combination must be unique.

{
  "values": {}
}

{
  "data": {}
}

Attach a product as a variant

Attach an existing product to a model as a variant. Its name is kept.

{
  "values": {}
}

{
  "data": {}
}

Detach a variant

Detach a variant, turning it into a regular product. Its option values are removed, its name is kept.

{
  "data": {}
}

Get the variant matrix

Data for an option × option matrix, with stock for every warehouse in each cell.

{
  "data": {}
}

List product images

Images of a product (metadata only, no bytes). The cover image comes first.

{
  "data": []
}

Get image content

Image content: for a URL image returns the link, for an uploaded image returns base64 data.

{
  "data": {}
}

Get cover images

The cover image of each product in the list — for thumbnails.

{
  "productIds": {}
}

{
  "data": []
}

Add an image

Add an image to the end of the gallery: either kind="url" with url, or kind="blob" with dataBase64 (and mimeType). The first image becomes the cover.

{
  "input": {}
}

{
  "data": 1
}

Delete an image

Delete an image.

{
  "data": null
}

Reorder images

Reorder product images; the first id becomes the cover. Ids not listed are left unchanged.

{
  "orderedIds": {}
}

{
  "data": null
}

List barcodes

All barcodes of a product, primary first.

{
  "data": []
}

Add a barcode

Add a barcode. It is normalized and its type is detected automatically. The first barcode, or one added with isPrimary, becomes primary.

{
  "input": {}
}

{
  "data": 1
}

Set the primary barcode

Make a barcode the primary one.

{
  "data": null
}

Delete a barcode

Delete a barcode. If it was primary, the next remaining one becomes primary.

{
  "data": null
}

List warehouses

List warehouses. Archived ones are included only with includeArchived.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "name": "Sample",
      "code": "CODE",
      "type": "string",
      "address": "string",
      "contact": "string",
      "comment": "string",
      "capacity": 9.99,
      "isDefault": false,
      "isArchived": false,
      "createdAtUtc": "2026-01-01T00:00:00.000Z",
      "updatedAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create a warehouse

Create a warehouse.

{
  "warehouse": {
    "name": "Sample",
    "code": "CODE",
    "type": "string",
    "address": "string",
    "contact": "string",
    "comment": "string",
    "capacity": 9.99,
    "isDefault": false,
    "isArchived": false
  }
}

{
  "data": 1
}

Update a warehouse

Update a warehouse. Its type can be changed, or it can be archived, only when it holds no stock, reservations or open orders.

{
  "data": {
    "name": "Sample",
    "code": "CODE",
    "type": "string",
    "address": "string",
    "contact": "string",
    "comment": "string",
    "capacity": 9.99,
    "isDefault": false,
    "isArchived": false
  }
}

{
  "data": null
}

Delete a warehouse

Delete a warehouse. Not allowed if it holds stock, active reservations or open orders; a warehouse with history can only be archived.

{
  "data": null
}

Set the default warehouse

Set the default warehouse. It must be active and not a supplier warehouse.

{
  "data": null
}

List categories

List categories.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "name": "Sample",
      "parentId": 1,
      "createdAtUtc": "2026-01-01T00:00:00.000Z",
      "updatedAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create a category

Create a category.

{
  "category": {
    "name": "Sample",
    "parentId": 1
  }
}

{
  "data": 1
}

Update a category

Update a category.

{
  "data": {
    "name": "Sample",
    "parentId": 1
  }
}

{
  "data": null
}

Delete a category

Delete a category.

{
  "data": null
}

List manufacturers

List manufacturers.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "name": "Sample",
      "createdAtUtc": "2026-01-01T00:00:00.000Z",
      "updatedAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create a manufacturer

Create a manufacturer.

{
  "manufacturer": {
    "name": "Sample"
  }
}

{
  "data": 1
}

Update a manufacturer

Update a manufacturer.

{
  "data": {
    "name": "Sample"
  }
}

{
  "data": null
}

Delete a manufacturer

Delete a manufacturer.

{
  "data": null
}

List currencies

List currencies.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "name": "Sample",
      "rate": 9.99,
      "isDefault": false,
      "createdAtUtc": "2026-01-01T00:00:00.000Z",
      "updatedAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create a currency

Create a currency.

{
  "currency": {
    "name": "Sample",
    "rate": 9.99,
    "isDefault": false
  }
}

{
  "data": 1
}

Update a currency

Update a currency.

{
  "data": {
    "name": "Sample",
    "rate": 9.99,
    "isDefault": false
  }
}

{
  "data": null
}

Delete a currency

Delete a currency.

{
  "data": null
}

Set the base currency

Set the base currency. All rates are relative to it, so they are recalculated: rate := rate / rate of the new base currency.

{
  "data": null
}

List suppliers

List suppliers.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "name": "Sample",
      "code": "CODE",
      "contact": "string",
      "email": "user@example.com",
      "phone": "string",
      "address": "string",
      "comment": "string",
      "isArchived": false,
      "createdAtUtc": "2026-01-01T00:00:00.000Z",
      "updatedAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create a supplier

Create a supplier.

{
  "supplier": {
    "name": "Sample",
    "code": "CODE",
    "contact": "string",
    "email": "user@example.com",
    "phone": "string",
    "address": "string",
    "comment": "string",
    "isArchived": false
  }
}

{
  "data": 1
}

Update a supplier

Update a supplier.

{
  "data": {
    "name": "Sample",
    "code": "CODE",
    "contact": "string",
    "email": "user@example.com",
    "phone": "string",
    "address": "string",
    "comment": "string",
    "isArchived": false
  }
}

{
  "data": null
}

Delete a supplier

Delete a supplier. Suppliers with purchase orders can only be archived.

{
  "data": null
}

List customers

List customers.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "name": "Sample",
      "code": "CODE",
      "contact": "string",
      "email": "user@example.com",
      "phone": "string",
      "address": "string",
      "comment": "string",
      "isArchived": false,
      "createdAtUtc": "2026-01-01T00:00:00.000Z",
      "updatedAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create a customer

Create a customer.

{
  "customer": {
    "name": "Sample",
    "code": "CODE",
    "contact": "string",
    "email": "user@example.com",
    "phone": "string",
    "address": "string",
    "comment": "string",
    "isArchived": false
  }
}

{
  "data": 1
}

Update a customer

Update a customer.

{
  "data": {
    "name": "Sample",
    "code": "CODE",
    "contact": "string",
    "email": "user@example.com",
    "phone": "string",
    "address": "string",
    "comment": "string",
    "isArchived": false
  }
}

{
  "data": null
}

Delete a customer

Delete a customer. Customers with orders can only be archived.

{
  "data": null
}

List custom fields

List custom product fields.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "name": "Sample",
      "type": "string",
      "sortOrder": 1,
      "createdAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create a custom field

Create a custom product field. Returns its id.

{
  "data": {}
}

{
  "data": 1
}

Update a custom field

Rename a custom field or change its type.

{
  "data": {}
}

{
  "data": null
}

Delete a custom field

Delete a custom field.

{
  "data": null
}

Receive stock

Receive stock into a warehouse. Returns the operation id.

{
  "input": {}
}

{
  "data": 1
}

Issue stock

Issue stock from a warehouse.

{
  "input": {}
}

{
  "data": 1
}

Adjust stock

Set stock to the given quantity.

{
  "input": {}
}

{
  "data": 1
}

Transfer stock

Move stock between warehouses.

{
  "input": {}
}

{
  "data": 1
}

Reserve stock

Reserve stock.

{
  "input": {}
}

{
  "data": 1
}

Reserve stock in bulk

Reserve stock in several warehouses in a single transaction: if any reservation fails, nothing is saved.

{
  "inputs": {}
}

{
  "data": {}
}

Release a reservation

Release a reservation.

{
  "input": {}
}

{
  "data": 1
}

Ship reserved stock

Ship reserved stock.

{
  "input": {}
}

{
  "data": 1
}

Receive a return

Receive a customer return.

{
  "input": {}
}

{
  "data": 1
}

Write off stock

Write off stock.

{
  "input": {}
}

{
  "data": 1
}

Run stock operations in bulk

Run a batch of stock operations.

{
  "input": {}
}

{
  "data": 1
}

Undo a movement

Undo a single stock movement within the undo window. Assembly movements can only be undone as a whole operation; a movement can be undone once.

{
  "data": null
}

Check stock integrity

Report stock inconsistencies. Read-only.

{
  "data": {}
}

Repair stock integrity

Fix stock inconsistencies: recalculates reserved and available quantities. Physical stock is not changed; if the movement log disagrees with it, a corrective adjustment is recorded.

{
  "data": {}
}

Reconcile stock with a file

Compare uploaded counts ({sku, warehouse, uploadedQty}) with current stock and return the differences. Warehouses match by name (case-insensitive) or id.

{
  "rows": {}
}

{
  "data": {}
}

Reconcile a stock count

Compare a stock count with current balances. Duplicate (SKU, warehouse) rows are summed; invalid quantities and archived or supplier warehouses are reported as row errors.

{
  "rows": {},
  "opts": {}
}

{
  "data": {}
}

Apply a stock count

Apply a stock count across all warehouses in one transaction. A row is applied only if stock has not changed since reconciliation; otherwise it is returned in changed.

{
  "input": {}
}

{
  "data": {}
}

Assemble products

Assemble N units: consumes components and adds the finished product at its computed cost.

{
  "input": {}
}

{
  "data": {}
}

Disassemble products

Disassemble N units according to the current bill of materials, returning components to stock.

{
  "input": {}
}

{
  "data": {}
}

Undo an assembly

Undo an entire assembly or disassembly operation within the undo window. A purchase price changed by the assembly is restored if it has not changed since.

{
  "data": {}
}

How many can be assembled

How many units can be assembled in a warehouse from the stock of direct components.

{
  "data": {}
}

Get product stock

Stock of a product in a warehouse: quantity, reserved and available.

{
  "data": {
    "id": 1,
    "campaignId": 1,
    "warehouseId": 1,
    "productId": 1,
    "qty": 9.99,
    "reservedQty": 9.99,
    "availableQty": 9.99,
    "lastMovementAtUtc": "2026-01-01T00:00:00.000Z",
    "updatedAtUtc": "2026-01-01T00:00:00.000Z"
  }
}

List stock balances

Stock balances, optionally for one warehouse.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "warehouseId": 1,
      "productId": 1,
      "qty": 9.99,
      "reservedQty": 9.99,
      "availableQty": 9.99,
      "lastMovementAtUtc": "2026-01-01T00:00:00.000Z",
      "updatedAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Search stock balances

Paginated stock balances with warehouse and status filters, search by name or SKU, and sorting.

{
  "data": {
    "items": [
      {
        "id": 1,
        "campaignId": 1,
        "warehouseId": 1,
        "productId": 1,
        "qty": 9.99,
        "reservedQty": 9.99,
        "availableQty": 9.99,
        "lastMovementAtUtc": "2026-01-01T00:00:00.000Z",
        "updatedAtUtc": "2026-01-01T00:00:00.000Z"
      }
    ],
    "totalCount": 1
  }
}

Stock totals per warehouse

Total physical stock per warehouse.

{
  "data": {}
}

Kit availability

Paginated kits with their computed stock.

{
  "data": {
    "items": [],
    "totalCount": 0
  }
}

List movements

Stock movements, with optional filters.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "warehouseId": 1,
      "productId": 1,
      "sku": "ABC-1",
      "movementType": "string",
      "qtyDelta": 9.99,
      "reservedDelta": 9.99,
      "qtyBefore": 9.99,
      "qtyAfter": 9.99,
      "reservedBefore": 9.99,
      "reservedAfter": 9.99,
      "purchasePrice": 9.99,
      "purchaseCurrencyId": 1,
      "documentType": "string",
      "documentNumber": "string",
      "operationId": 1,
      "comment": "string",
      "createdAtUtc": "2026-01-01T00:00:00.000Z",
      "createdBy": "string",
      "createdBySource": "string",
      "reversesMovementId": 1
    }
  ]
}

Search movements

Paginated stock movements.

{
  "data": {
    "items": [
      {
        "id": 1,
        "campaignId": 1,
        "warehouseId": 1,
        "productId": 1,
        "sku": "ABC-1",
        "movementType": "string",
        "qtyDelta": 9.99,
        "reservedDelta": 9.99,
        "qtyBefore": 9.99,
        "qtyAfter": 9.99,
        "reservedBefore": 9.99,
        "reservedAfter": 9.99,
        "purchasePrice": 9.99,
        "purchaseCurrencyId": 1,
        "documentType": "string",
        "documentNumber": "string",
        "operationId": 1,
        "comment": "string",
        "createdAtUtc": "2026-01-01T00:00:00.000Z",
        "createdBy": "string",
        "createdBySource": "string",
        "reversesMovementId": 1
      }
    ],
    "totalCount": 1
  }
}

List reservations

Reservations, optionally filtered by status or date. Expired reservations are released first.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "warehouseId": 1,
      "productId": 1,
      "qtyReserved": 9.99,
      "status": "Active",
      "reasonType": "string",
      "documentType": "string",
      "documentNumber": "string",
      "expiresAtUtc": "2026-01-01T00:00:00.000Z",
      "comment": "string",
      "createdAtUtc": "2026-01-01T00:00:00.000Z",
      "updatedAtUtc": "2026-01-01T00:00:00.000Z",
      "releasedAtUtc": "2026-01-01T00:00:00.000Z",
      "orderItemId": 1
    }
  ]
}

Search reservations

Paginated reservations with filters, search and sorting. Returns {items, totalCount}.

{
  "data": {
    "items": [
      {
        "id": 1,
        "campaignId": 1,
        "warehouseId": 1,
        "productId": 1,
        "qtyReserved": 9.99,
        "status": "Active",
        "reasonType": "string",
        "documentType": "string",
        "documentNumber": "string",
        "expiresAtUtc": "2026-01-01T00:00:00.000Z",
        "comment": "string",
        "createdAtUtc": "2026-01-01T00:00:00.000Z",
        "updatedAtUtc": "2026-01-01T00:00:00.000Z",
        "releasedAtUtc": "2026-01-01T00:00:00.000Z",
        "orderItemId": 1
      }
    ],
    "totalCount": 1
  }
}

List sales orders

List sales orders.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "orderNumber": "string",
      "customerId": 1,
      "source": "string",
      "status": "Active",
      "comment": "string",
      "createdAtUtc": "2026-01-01T00:00:00.000Z",
      "updatedAtUtc": "2026-01-01T00:00:00.000Z",
      "cancelledAtUtc": "2026-01-01T00:00:00.000Z",
      "shippedAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Search sales orders

Paginated sales orders.

{
  "data": {
    "items": [
      {
        "id": 1,
        "campaignId": 1,
        "orderNumber": "string",
        "customerId": 1,
        "source": "string",
        "status": "Active",
        "comment": "string",
        "createdAtUtc": "2026-01-01T00:00:00.000Z",
        "updatedAtUtc": "2026-01-01T00:00:00.000Z",
        "cancelledAtUtc": "2026-01-01T00:00:00.000Z",
        "shippedAtUtc": "2026-01-01T00:00:00.000Z"
      }
    ],
    "totalCount": 1
  }
}

Get a sales order

Get a sales order with its lines.

{
  "data": {
    "id": 1,
    "campaignId": 1,
    "orderNumber": "string",
    "customerId": 1,
    "source": "string",
    "status": "Active",
    "comment": "string",
    "createdAtUtc": "2026-01-01T00:00:00.000Z",
    "updatedAtUtc": "2026-01-01T00:00:00.000Z",
    "cancelledAtUtc": "2026-01-01T00:00:00.000Z",
    "shippedAtUtc": "2026-01-01T00:00:00.000Z"
  }
}

Create a sales order

Create a sales order.

{
  "input": {}
}

{
  "data": 1
}

Next order number

Next free document number for a prefix (e.g. “ORD-20261006-”).

{
  "data": {}
}

Update a sales order

Update a sales order (not shipped or cancelled). Lines are the full list: with id — existing, without id — new, omitted — deleted. Reservations are adjusted automatically.

{
  "input": {}
}

{
  "data": {}
}

Reserve stock for an order

Reserve stock for an order. Reserves what is available; a partial reservation sets the status to “Partially reserved”. Fails only if nothing could be reserved.

{
  "data": {}
}

Ship an order

Ship an order and deduct stock.

{
  "data": null
}

Cancel an order

Cancel an order and release its reservations atomically.

{
  "data": null
}

List purchase orders

List purchase orders.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "orderNumber": "string",
      "supplierId": 1,
      "status": "Active",
      "expectedAtUtc": "2026-01-01T00:00:00.000Z",
      "comment": "string",
      "createdAtUtc": "2026-01-01T00:00:00.000Z",
      "updatedAtUtc": "2026-01-01T00:00:00.000Z",
      "cancelledAtUtc": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Search purchase orders

Paginated purchase orders with search by number and status filter.

{
  "data": {
    "items": [
      {
        "id": 1,
        "campaignId": 1,
        "orderNumber": "string",
        "supplierId": 1,
        "status": "Active",
        "expectedAtUtc": "2026-01-01T00:00:00.000Z",
        "comment": "string",
        "createdAtUtc": "2026-01-01T00:00:00.000Z",
        "updatedAtUtc": "2026-01-01T00:00:00.000Z",
        "cancelledAtUtc": "2026-01-01T00:00:00.000Z"
      }
    ],
    "totalCount": 1
  }
}

Get a purchase order

Get a purchase order.

{
  "data": {
    "id": 1,
    "campaignId": 1,
    "orderNumber": "string",
    "supplierId": 1,
    "status": "Active",
    "expectedAtUtc": "2026-01-01T00:00:00.000Z",
    "comment": "string",
    "createdAtUtc": "2026-01-01T00:00:00.000Z",
    "updatedAtUtc": "2026-01-01T00:00:00.000Z",
    "cancelledAtUtc": "2026-01-01T00:00:00.000Z"
  }
}

Create a purchase order

Create a purchase order.

{
  "input": {}
}

{
  "data": 1
}

Next purchase order number

Next free purchase order number for a prefix (e.g. “PO-20261006-”).

{
  "data": {}
}

Update a purchase order

Update a purchase order (not fully received or cancelled). Lines are the full list, as in updateOrder. Quantities cannot go below what was received; omitted prices keep their values.

{
  "input": {}
}

{
  "data": {}
}

Receive a purchase order

Receive goods against a purchase order.

{
  "input": {}
}

{
  "data": 1
}

Cancel a purchase order

Cancel a purchase order.

{
  "data": null
}

Stock and margin summary

Summary of stock, cost and margin.

{
  "data": {}
}

Reports for a period

Reports for a period: inventory, sales, purchasing, movements, ABC analysis and turnover, optionally per warehouse.

{
  "data": {}
}

Dashboard summary

Dashboard summary: product count, stock value, out-of-stock and low-stock items, charts by category and warehouse.

{
  "data": {}
}

Get settings

Get workspace settings.

{
  "data": {
    "id": 1,
    "campaignId": 1,
    "locale": "string",
    "allowNegativeStock": false,
    "allowOverReservation": false,
    "defaultExportQuantityMode": "string",
    "dateFormat": "2026-01-01T00:00:00.000Z",
    "timeFormat": "string",
    "decimalSeparator": "string",
    "thousandsSeparator": "string",
    "lastWarehouseId": 1,
    "lastBackupReminderDate": "2026-01-01T00:00:00.000Z",
    "lastBackupAtUtc": "2026-01-01T00:00:00.000Z",
    "defaultBackupTarget": "string",
    "featureKits": false,
    "featureVariants": false,
    "featuresRolloutDone": false,
    "timeZone": "string"
  }
}

Update settings

Update workspace settings.

{
  "updates": {
    "locale": "string",
    "allowNegativeStock": false,
    "allowOverReservation": false,
    "defaultExportQuantityMode": "string",
    "dateFormat": "2026-01-01T00:00:00.000Z",
    "timeFormat": "string",
    "decimalSeparator": "string",
    "thousandsSeparator": "string",
    "lastWarehouseId": 1,
    "lastBackupReminderDate": "2026-01-01T00:00:00.000Z",
    "lastBackupAtUtc": "2026-01-01T00:00:00.000Z",
    "defaultBackupTarget": "string",
    "featureKits": false,
    "featureVariants": false,
    "featuresRolloutDone": false,
    "timeZone": "string"
  }
}

{
  "data": null
}

Import history

History of import and export jobs.

{
  "data": [
    {
      "id": 1,
      "campaignId": 1,
      "type": "string",
      "fileName": "string",
      "fileType": "string",
      "format": "string",
      "profileId": 1,
      "updateMode": "2026-01-01T00:00:00.000Z",
      "stockImportMode": "string",
      "defaultWarehouseId": 1,
      "status": "Active",
      "rowsTotal": 1,
      "rowsProcessed": 1,
      "productsCreated": 1,
      "productsUpdated": 1,
      "categoriesCreated": 1,
      "manufacturersCreated": 1,
      "currenciesCreated": 1,
      "stockBalancesUpdated": 1,
      "rowsSkipped": 1,
      "errorsCount": 1,
      "warningsCount": 1,
      "messages": {},
      "startedAtUtc": "2026-01-01T00:00:00.000Z",
      "finishedAtUtc": "2026-01-01T00:00:00.000Z",
      "resultBlob": "string",
      "undoData": {}
    }
  ]
}

Create an import job

Create an import job.

{
  "job": {
    "type": "string",
    "fileName": "string",
    "fileType": "string",
    "format": "string",
    "profileId": 1,
    "updateMode": "2026-01-01T00:00:00.000Z",
    "stockImportMode": "string",
    "defaultWarehouseId": 1,
    "status": "Active",
    "rowsTotal": 1,
    "rowsProcessed": 1,
    "productsCreated": 1,
    "productsUpdated": 1,
    "categoriesCreated": 1,
    "manufacturersCreated": 1,
    "currenciesCreated": 1,
    "stockBalancesUpdated": 1,
    "rowsSkipped": 1,
    "errorsCount": 1,
    "warningsCount": 1,
    "messages": {},
    "startedAtUtc": "2026-01-01T00:00:00.000Z",
    "finishedAtUtc": "2026-01-01T00:00:00.000Z",
    "resultBlob": "string",
    "undoData": {}
  }
}

{
  "data": 1
}

Update an import job

Update an import job.

{
  "updates": {
    "type": "string",
    "fileName": "string",
    "fileType": "string",
    "format": "string",
    "profileId": 1,
    "updateMode": "2026-01-01T00:00:00.000Z",
    "stockImportMode": "string",
    "defaultWarehouseId": 1,
    "status": "Active",
    "rowsTotal": 1,
    "rowsProcessed": 1,
    "productsCreated": 1,
    "productsUpdated": 1,
    "categoriesCreated": 1,
    "manufacturersCreated": 1,
    "currenciesCreated": 1,
    "stockBalancesUpdated": 1,
    "rowsSkipped": 1,
    "errorsCount": 1,
    "warningsCount": 1,
    "messages": {},
    "startedAtUtc": "2026-01-01T00:00:00.000Z",
    "finishedAtUtc": "2026-01-01T00:00:00.000Z",
    "resultBlob": "string",
    "undoData": {}
  }
}

{
  "data": null
}

Undo an import

Undo an import by deleting the records it created. Returns the number of deleted records.

{
  "data": {}
}

Import products

Import products: mapped fields, references by name (optionally created), kinds and variants.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Import stock

Import stock or movements by SKU. Unknown SKUs are reported, or created with createMissingProducts.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Import customers

Import customers.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Import suppliers

Import suppliers.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Import categories

Import categories; hierarchy is written as “Parent -> Child”.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Import manufacturers

Import manufacturers.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Import warehouses

Import warehouses.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Import currencies

Import currencies.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Import sales orders

Import sales orders; rows are grouped by order number.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Import purchase orders

Import purchase orders; rows are grouped by order number.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Import movements

Import movements: qty > 0 receives, qty < 0 issues; with a target warehouse the row becomes a transfer.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Import reservations

Import reservations: one reservation per row.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Import bills of materials

Import bills of materials: “product SKU, component SKU, quantity”. Replaces existing components and sets the product kind to assembled.

{
  "items": {},
  "opts": {}
}

{
  "data": {}
}

Delete all data

Delete ALL workspace data (products, stock, documents, reference data, import history). Settings are kept. Returns the number of cleared tables.

{
  "data": {}
}

Clean up orphaned stock records

Delete stock records that reference deleted products. Returns the number of deleted rows per table.

{
  "data": {}
}

List activity

Activity log, newest first. search matches the description and method name.

{
  "data": {}
}

Activity summary

Activity summary. userId limits it to one user.

{
  "data": {}
}