Skip to content

Your API (Popis pulls) ​

Popis calls your API and fetches the codebooks. In the portal, choose the We pull from their API mode, enter the API URL and API Key and tick what is synced (API sync).

Every call Popis sends, with its fields and examples: API reference

The requests Popis sends ​

For each ticked codebook Popis sends one request:

http
GET {API URL}/articles
GET {API URL}/fixed-assets
GET {API URL}/locations
GET {API URL}/warehouses

X-API-Key: <API Key>
Accept: application/json

Your API should:

  • answer with a 2xx code and the header Content-Type: application/json;
  • return all records at once (Popis doesn't page), as an array [ … ] or as { "data": [ … ] };
  • answer within 60 seconds.

Example response for /articles:

json
[
  { "code": "ART001", "name": "Milk 1L", "unit": "pcs", "price": 89.99, "tax_rate": 20, "weight": 1.05, "status": "active" },
  { "code": "ART002", "name": "White bread", "unit": "pcs", "price": 45 }
]

Fields Popis reads ​

EndpointKeyFields
/articlescodename, unit, price, tax_rate, weight, description, status
/fixed-assetsinventory_numbername, unit, serial_number, type (fixed_asset / small_inventory), quantity, price, description, status
/locationscodename, city, address, email, status
/warehousescodename, location_code, status
  • A record without its key (code, or inventory_number) is skipped. status is active or inactive (otherwise active).
  • Existing records are matched by key and updated, new ones are added. Fetching never deletes anything in Popis.
  • A warehouse needs the location_code of a location that already exists in Popis — so sync locations before warehouses.
  • Popis doesn't take barcodes through this API; enter them in Popis or send them through the Popis API.

You fetch the data by hand, with the Manual Sync buttons in the portal; there is no automatic fetching.

Test connection ​

Test Connection in the portal calls each ticked endpoint and checks that the first record has its key and name. Messages: All N endpoints validated successfully., Missing required field "…" in response data., Response is not a valid JSON array.

The report after a count ​

If Auto-send report on count completion is ticked, Popis sends this after every completed count (in the portal or the app):

http
POST {API URL}/report
X-API-Key: <API Key>
Content-Type: application/json
json
{
  "count_number": "DOK-0022-2026",
  "type": "goods",
  "mode": "complete",
  "status": "completed",
  "location": "Location 1",
  "warehouse": "Main warehouse",
  "items": [
    { "code": "ART001", "name": "Milk 1L", "unit": "pcs", "counted": 98, "price": 89.99, "barcode": "8600001234567",
      "rows": [ { "list_number": "LST-0013-2026", "bin": null, "serial": null, "lot": null, "quantity": 98, "expire_date": null } ] }
  ]
}

For fixed-asset counts code is the inventory number. rows are the individual entries from the count lists (with position, serial number or lot and its expiry date, where tracked). Your API should answer within 30 seconds.