Products

Adding Products

The complete product form, field by field.

Last updated 2026-10-13

DigitalKey ERP — Docs · digital-key.co/docs/products/add-product

Overview

Only a name and the prices are genuinely needed to start selling. Everything else makes the product easier to find, count and report on, and can be filled in later.

  1. 1

    Open the product form

    Go to Products and choose Add Product.

    Products — Product list with the add button
    Product list with the add button
    Product list with the add button — The catalogue screen highlighting where a new product is started.
  2. 2

    Enter the identity fields

    Give the product a name — this is what the cashier sees. Scan or type a barcode, or press Generate to have a free one made for you. Add a SKU if you use your own coding.

    Products — Product form, identity section
    Product form, identity section
    Product form, identity section — Name, category, unit, barcode, SKU, colour and serial number fields.
  3. 3

    Set the prices

    Enter what the item costs you and what you sell it for. The cost price is what makes profit reporting possible, so it is worth filling in accurately. A selling price lower than the purchase price is refused.

  4. 4

    Set the opening stock

    Enter the quantity you currently hold and, if you want to be warned when it runs low, the alert level. With more than one warehouse you can also say where the opening stock sits.

    Products — Product form, stock section
    Product form, stock section
    Product form, stock section — Stock quantity, alert level, pack size and expiry date fields.
  5. 5

    Upload an image (optional)

    A picture makes the product easier to pick out in the POS grid. JPG and PNG are accepted.

  6. 6

    Save

    The product becomes sellable in the POS straight away.

Product fields

POST /api/v1/products
ParameterTypeRequiredDescription
namestringRequiredProduct name shown in the POS and printed on invoices.
category_idintegerOptionalCategory this product belongs to.
unit_idintegerOptionalUnit of measure — piece, box, kg and so on.
barcodestringOptionalBarcode value. Matched by scanner search in the POS.
skustringOptionalYour own stock-keeping code.
serial_numberstringOptionalSerial number, for serialised goods.
colorstringOptionalColour or variant label.
descriptionstringOptionalLonger description. Not printed on invoices.
unit_qtyinteger= 1OptionalItems per Unit — how many pieces make up one unit (the carton size).
sell_by_pieceboolean= falseOptionalSell by the piece: stock, cost and price count single pieces. Needs Items per Unit above 1.
pack_pricedecimalOptionalCarton price, when the product is sold by the piece.
purchase_pricedecimalRequiredCost price, in your main currency. The starting point of the weighted average; later receipts blend into it.
sell_price1decimalRequiredRetail price. The default selling price. May not be below the purchase price.
sell_price2decimalOptionalWholesale price, selected with price level 2. May not be below the purchase price.
discount_pctdecimalOptionalDefault discount percentage pre-filled when the item is added to a cart.
qty_in_stockdecimalRequiredOpening quantity on hand.
qty_alertdecimalOptionalLow-stock threshold. At or below this the item is flagged.
expiry_datedateOptionalExpiry date, for perishable or dated goods.
image_urlstringOptionalPath to the product image, set by the upload.
initial_warehouse_idintegerOptionalWhich warehouse the opening stock is placed in. Only meaningful with more than one warehouse.

Price levels

Notesell_price1 is the retail price and is used by default. sell_price2 is the wholesale price. The level is chosen per sales order through its price_level field, which takes the value 1 or 2.

Who can add and edit

The owner, and staff with Add / edit products. Uploading an image needs product.image_upload. A product can also be created on the spot from a purchase line, where it can be given a selling price straight away — a product with no price cannot be sold until one is set.

Cost after the first save

NoteThe purchase price you type here is where the product's cost starts. From then on, receiving stock blends the new cost into a weighted average rather than replacing it. See Product Cost.

Stock alerts

When qty_in_stock falls to or below qty_alert, the product is treated as low on stock: it is flagged in the product list and appears in warehouse alerts.

WarningThe warehouse alerts view needs warehouse.alerts. Without it the threshold is still recorded and still shown in the product list.

Images

Images are uploaded through POST /api/v1/products/upload-image, which accepts JPG and PNG only (max 2MB) and returns the full public URL to put in image_url. Files are stored in Cloudflare R2 and served from the asset domain; the filename is a hash of the image content, so it cannot be guessed.

NoteBecause product images are served publicly, do not upload anything you would not want visible to someone with the link.

Related