{ "info": { "_postman_id": "608a1be2-6c05-5af1-b310-017a95253cc1", "name": "Next Inventory REST API (docs v6)", "description": "The REST API of Next Inventory, the inventory component for Joomla 4, 5 and 6.\n\n**Base URL**: `https:///api/index.php/v1/nextinventory`\n\n**Authentication**: create a token in Next Inventory → Configuration → REST API → Tokens and send it as\n`Authorization: Bearer `. If your web server strips the Authorization header (some Apache\n+ PHP-FPM setups do), send `X-NextInventory-Token: ` instead.\n\nA token acts as the user who created it. It can do only what its **scopes** allow AND what that\nuser's Next Inventory **role** allows; every request goes through the same permission checks,\nvalidation and stock rules as the Next Inventory screens.\n\n**Responses**: success is `{ \"data\": ..., \"meta\": { \"total\": n } }` (meta on lists only); a create\nanswers `201`, a delete `204` with no body. Every failure is\n`{ \"errors\": [ { \"title\": \"...\", \"code\": \"MACHINE_CODE\", \"meta\": { ... } } ] }`.\n\n**Stock is changed only through stock movements, transfers and adjustments** — never by writing\n`stock_quantity` on an item — so every change is in the ledger (`/transactions`) and the\nFIFO/LIFO cost layers stay correct.\n\n**Rate limits**: per token and per minute, reads (GET) and changes counted apart: 300 reads\nand 120 changes by default, set on REST API → Settings (0 = no limit). Every answer carries\n`RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset` (seconds); over a limit the\nanswer is `429 RATE_LIMITED` with `Retry-After: `. More than 20 unknown tokens from one\naddress within 5 minutes are answered `429 TOO_MANY_FAILED_LOGINS` (a valid token never is).\n\n**Concurrent edits**: reading one record (`GET /items/{id}` and the like) returns an `ETag`\nheader, as does a successful change to it. Send it back as `If-Match` on `PATCH`, `DELETE` or\nan action, and the change is refused with `412` if someone else changed the record meanwhile.\nTo learn when records change, subscribe a webhook rather than polling.\n\n**Safe retries**: send an `Idempotency-Key` header on a POST, PATCH or DELETE and a retry\nafter a timeout cannot run the request twice (see the parameter).\n\nThe same token also works on the administrator task lane\n(`administrator/index.php?option=com_nextinventory&format=json&task=`), which\nis the RPC interface the Next Inventory screens themselves use.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://example.com/api/index.php/v1/nextinventory", "type": "string" }, { "key": "apiToken", "value": "", "type": "string" } ], "item": [ { "name": "Items", "item": [ { "name": "GET List Items", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items?", "host": [ "{{baseUrl}}" ], "path": [ "items" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "category_id", "value": "", "disabled": true }, { "key": "warehouse_id", "value": "", "disabled": true }, { "key": "item_type", "value": "", "disabled": true }, { "key": "low_stock", "value": "", "disabled": true }, { "key": "published", "value": "", "disabled": true }, { "key": "ordering", "value": "title", "disabled": true }, { "key": "direction", "value": "", "disabled": true } ] }, "description": "List items\n\nScope `items:read`; role permission `inventory.view`." }, "response": [ { "name": "200 A page of items.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items?", "host": [ "{{baseUrl}}" ], "path": [ "items" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "category_id", "value": "", "disabled": true }, { "key": "warehouse_id", "value": "", "disabled": true }, { "key": "item_type", "value": "", "disabled": true }, { "key": "low_stock", "value": "", "disabled": true }, { "key": "published", "value": "", "disabled": true }, { "key": "ordering", "value": "title", "disabled": true }, { "key": "direction", "value": "", "disabled": true } ] }, "description": "List items\n\nScope `items:read`; role permission `inventory.view`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"string\",\n \"alias\": \"string\",\n \"item_type\": \"asset\",\n \"sku\": \"string\",\n \"barcode\": \"string\",\n \"serial_number\": \"string\",\n \"category_id\": 1,\n \"category_title\": \"string\",\n \"warehouse_id\": 1,\n \"warehouse_title\": \"string\",\n \"unit_id\": 1,\n \"unit_title\": \"string\",\n \"unit_code\": \"string\",\n \"stock_quantity\": 1.5,\n \"unit_price\": 1.5,\n \"low_stock_threshold\": 1.5,\n \"weight\": 1.5,\n \"weight_unit\": \"string\",\n \"track_weight\": true,\n \"description\": \"string\",\n \"image\": \"string\",\n \"state\": 1,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}" } ] }, { "name": "POST Create Item", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items", "host": [ "{{baseUrl}}" ], "path": [ "items" ] }, "description": "Create an item\n\nScope `items:write`; role permission `inventory.create`. Required: `title`, `item_type`,\n`category_id`, `stock_quantity`, `low_stock_threshold` (send 0 for none). Custom fields are sent as `cf_` keys. Opening stock is better\nrecorded with an `add_stock` movement so it reaches the ledger.", "body": { "mode": "raw", "raw": "{\n \"title\": \"Cordless drill\",\n \"item_type\": \"asset\",\n \"category_id\": 3,\n \"warehouse_id\": 1,\n \"sku\": \"TL-0042\",\n \"stock_quantity\": 0,\n \"unit_price\": 129.9,\n \"low_stock_threshold\": 2,\n \"state\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Created.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items", "host": [ "{{baseUrl}}" ], "path": [ "items" ] }, "description": "Create an item\n\nScope `items:write`; role permission `inventory.create`. Required: `title`, `item_type`,\n`category_id`, `stock_quantity`, `low_stock_threshold` (send 0 for none). Custom fields are sent as `cf_` keys. Opening stock is better\nrecorded with an `add_stock` movement so it reaches the ledger.", "body": { "mode": "raw", "raw": "{\n \"title\": \"Cordless drill\",\n \"item_type\": \"asset\",\n \"category_id\": 3,\n \"warehouse_id\": 1,\n \"sku\": \"TL-0042\",\n \"stock_quantity\": 0,\n \"unit_price\": 129.9,\n \"low_stock_threshold\": 2,\n \"state\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "GET Get Item", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one item, with its custom fields\n\nScope `items:read`." }, "response": [ { "name": "200 The item.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one item, with its custom fields\n\nScope `items:read`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"title\": \"string\",\n \"alias\": \"string\",\n \"item_type\": \"asset\",\n \"sku\": \"string\",\n \"barcode\": \"string\",\n \"serial_number\": \"string\",\n \"category_id\": 1,\n \"category_title\": \"string\",\n \"warehouse_id\": 1,\n \"warehouse_title\": \"string\",\n \"unit_id\": 1,\n \"unit_title\": \"string\",\n \"unit_code\": \"string\",\n \"stock_quantity\": 1.5,\n \"unit_price\": 1.5,\n \"low_stock_threshold\": 1.5,\n \"weight\": 1.5,\n \"weight_unit\": \"string\",\n \"track_weight\": true,\n \"description\": \"string\",\n \"image\": \"string\",\n \"state\": 1,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\",\n \"custom_fields\": [\n {\n \"name\": \"string\",\n \"label\": \"string\",\n \"field_type\": \"string\",\n \"value\": \"string\"\n }\n ]\n }\n}" } ] }, { "name": "PATCH Update Item", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Update an item (only the fields sent)\n\nScope `items:write`; role permission `inventory.edit`.", "body": { "mode": "raw", "raw": "{\n \"unit_price\": 134.5\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 Done.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Update an item (only the fields sent)\n\nScope `items:write`; role permission `inventory.edit`.", "body": { "mode": "raw", "raw": "{\n \"unit_price\": 134.5\n}", "options": { "raw": { "language": "json" } } } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "DELETE Delete Item", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Delete an item\n\nScope `items:delete`; role permission `inventory.delete`." } }, { "name": "GET List Item Transactions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/transactions?", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "transactions" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true } ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "The ledger of one item\n\nScope `transactions:read`." }, "response": [ { "name": "200 A page of ledger rows.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/transactions?", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "transactions" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true } ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "The ledger of one item\n\nScope `transactions:read`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"item_id\": 1,\n \"item_title\": \"string\",\n \"item_sku\": \"string\",\n \"transaction_type\": \"string\",\n \"quantity_change\": 1.5,\n \"new_quantity\": 1.5,\n \"transaction_unit_id\": 1,\n \"original_quantity\": 1.5,\n \"cost_per_unit\": 1.5,\n \"total_cost\": 1.5,\n \"batch_id\": \"string\",\n \"recipient_id\": 1,\n \"recipient\": \"string\",\n \"reason\": \"string\",\n \"created_by\": 1,\n \"created_by_name\": \"string\",\n \"created\": \"2026-01-01T12:00:00Z\"\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}" } ] }, { "name": "GET Get Item Cost Layers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/cost-layers", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "cost-layers" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "FIFO/LIFO cost layers and valuation of one item\n\nScope `items:read`. Empty unless the costing method is FIFO or LIFO." }, "response": [ { "name": "200 Layers, total value and the active costing method.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/cost-layers", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "cost-layers" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "FIFO/LIFO cost layers and valuation of one item\n\nScope `items:read`. Empty unless the costing method is FIFO or LIFO." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"layers\": [\n {}\n ],\n \"total_value\": 1.5,\n \"costing_method\": \"standard\"\n }\n}" } ] }, { "name": "POST Set Item Image", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "url": { "raw": "{{baseUrl}}/items/:id/image", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "image" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Upload an image and make it the item's image\n\nScope `items:write`; role permission `inventory.edit`. Replaces any previous image. Thumbnails are generated.", "body": { "mode": "raw", "raw": "{\n \"image\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 The stored image.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "url": { "raw": "{{baseUrl}}/items/:id/image", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "image" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Upload an image and make it the item's image\n\nScope `items:write`; role permission `inventory.edit`. Replaces any previous image. Thumbnails are generated.", "body": { "mode": "raw", "raw": "{\n \"image\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"image\": \"string\",\n \"thumb_small\": \"string\",\n \"thumb_medium\": \"string\"\n }\n}" } ] }, { "name": "DELETE Remove Item Image", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id/image", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "image" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Remove the item's image\n\nScope `items:write`." }, "response": [ { "name": "200 Done.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id/image", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "image" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Remove the item's image\n\nScope `items:write`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] } ] }, { "name": "Lookup", "item": [ { "name": "GET Lookup Barcode", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lookup/barcode?barcode=", "host": [ "{{baseUrl}}" ], "path": [ "lookup", "barcode" ], "query": [ { "key": "barcode", "value": "" } ] }, "description": "Find the published item with an exact barcode\n\nScope `lookups:read`. 404 when nothing matches." }, "response": [ { "name": "200 The item.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lookup/barcode?barcode=", "host": [ "{{baseUrl}}" ], "path": [ "lookup", "barcode" ], "query": [ { "key": "barcode", "value": "" } ] }, "description": "Find the published item with an exact barcode\n\nScope `lookups:read`. 404 when nothing matches." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"title\": \"string\",\n \"alias\": \"string\",\n \"item_type\": \"asset\",\n \"sku\": \"string\",\n \"barcode\": \"string\",\n \"serial_number\": \"string\",\n \"category_id\": 1,\n \"category_title\": \"string\",\n \"warehouse_id\": 1,\n \"warehouse_title\": \"string\",\n \"unit_id\": 1,\n \"unit_title\": \"string\",\n \"unit_code\": \"string\",\n \"stock_quantity\": 1.5,\n \"unit_price\": 1.5,\n \"low_stock_threshold\": 1.5,\n \"weight\": 1.5,\n \"weight_unit\": \"string\",\n \"track_weight\": true,\n \"description\": \"string\",\n \"image\": \"string\",\n \"state\": 1,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n}" } ] }, { "name": "GET Lookup Sku", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lookup/sku?sku=", "host": [ "{{baseUrl}}" ], "path": [ "lookup", "sku" ], "query": [ { "key": "sku", "value": "" } ] }, "description": "Find the published item with an exact SKU\n\nScope `lookups:read`. 404 when nothing matches." }, "response": [ { "name": "200 The item.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lookup/sku?sku=", "host": [ "{{baseUrl}}" ], "path": [ "lookup", "sku" ], "query": [ { "key": "sku", "value": "" } ] }, "description": "Find the published item with an exact SKU\n\nScope `lookups:read`. 404 when nothing matches." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"title\": \"string\",\n \"alias\": \"string\",\n \"item_type\": \"asset\",\n \"sku\": \"string\",\n \"barcode\": \"string\",\n \"serial_number\": \"string\",\n \"category_id\": 1,\n \"category_title\": \"string\",\n \"warehouse_id\": 1,\n \"warehouse_title\": \"string\",\n \"unit_id\": 1,\n \"unit_title\": \"string\",\n \"unit_code\": \"string\",\n \"stock_quantity\": 1.5,\n \"unit_price\": 1.5,\n \"low_stock_threshold\": 1.5,\n \"weight\": 1.5,\n \"weight_unit\": \"string\",\n \"track_weight\": true,\n \"description\": \"string\",\n \"image\": \"string\",\n \"state\": 1,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n}" } ] }, { "name": "GET Lookup Search", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lookup/search?q=", "host": [ "{{baseUrl}}" ], "path": [ "lookup", "search" ], "query": [ { "key": "q", "value": "" } ] }, "description": "Up to 10 published items matching title, SKU, barcode or serial number\n\nScope `lookups:read`." }, "response": [ { "name": "200 Matches.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lookup/search?q=", "host": [ "{{baseUrl}}" ], "path": [ "lookup", "search" ], "query": [ { "key": "q", "value": "" } ] }, "description": "Up to 10 published items matching title, SKU, barcode or serial number\n\nScope `lookups:read`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"string\",\n \"alias\": \"string\",\n \"item_type\": \"asset\",\n \"sku\": \"string\",\n \"barcode\": \"string\",\n \"serial_number\": \"string\",\n \"category_id\": 1,\n \"category_title\": \"string\",\n \"warehouse_id\": 1,\n \"warehouse_title\": \"string\",\n \"unit_id\": 1,\n \"unit_title\": \"string\",\n \"unit_code\": \"string\",\n \"stock_quantity\": 1.5,\n \"unit_price\": 1.5,\n \"low_stock_threshold\": 1.5,\n \"weight\": 1.5,\n \"weight_unit\": \"string\",\n \"track_weight\": true,\n \"description\": \"string\",\n \"image\": \"string\",\n \"state\": 1,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n ]\n}" } ] } ] }, { "name": "Custom fields", "item": [ { "name": "GET List Custom Fields", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/custom-fields?", "host": [ "{{baseUrl}}" ], "path": [ "custom-fields" ], "query": [ { "key": "context", "value": "", "disabled": true } ] }, "description": "The published custom field definitions for items, warehouses or recipients\n\nScope `customfields:read`. Write a field as `cf_` on POST / PATCH of the entity.\nEmpty while the Custom Fields app is off." }, "response": [ { "name": "200 Definitions, in display order.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/custom-fields?", "host": [ "{{baseUrl}}" ], "path": [ "custom-fields" ], "query": [ { "key": "context", "value": "", "disabled": true } ] }, "description": "The published custom field definitions for items, warehouses or recipients\n\nScope `customfields:read`. Write a field as `cf_` on POST / PATCH of the entity.\nEmpty while the Custom Fields app is off." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"string\",\n \"label\": \"string\",\n \"description\": \"string\",\n \"field_type\": \"text\",\n \"context\": \"item\",\n \"default_value\": \"string\",\n \"options\": \"string\",\n \"validation_rules\": \"string\",\n \"is_required\": true,\n \"is_searchable\": true,\n \"is_filterable\": true,\n \"ordering\": 1,\n \"fieldset_name\": \"string\",\n \"fieldset_title\": \"string\"\n }\n ]\n}" } ] } ] }, { "name": "Categories", "item": [ { "name": "GET List Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories?", "host": [ "{{baseUrl}}" ], "path": [ "categories" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "published", "value": "", "disabled": true } ] }, "description": "List categories\n\nScope `categories:read`; role permission `categories.view`." }, "response": [ { "name": "200 A page of categories.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories?", "host": [ "{{baseUrl}}" ], "path": [ "categories" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "published", "value": "", "disabled": true } ] }, "description": "List categories\n\nScope `categories:read`; role permission `categories.view`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"code\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"published\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}" } ] }, { "name": "POST Create Category", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories", "host": [ "{{baseUrl}}" ], "path": [ "categories" ] }, "description": "Create a category\n\nScope `categories:write`; role permission `categories.create`. Required: `title`.", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"code\": \"string\",\n \"description\": \"string\",\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Created.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories", "host": [ "{{baseUrl}}" ], "path": [ "categories" ] }, "description": "Create a category\n\nScope `categories:write`; role permission `categories.create`. Required: `title`.", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"code\": \"string\",\n \"description\": \"string\",\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "GET Get Category", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one category\n\n" }, "response": [ { "name": "200 The category.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one category\n\n" }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"code\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"published\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n}" } ] }, { "name": "PATCH Update Category", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Update a category\n\n", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"code\": \"string\",\n \"description\": \"string\",\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 Done.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Update a category\n\n", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"code\": \"string\",\n \"description\": \"string\",\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "DELETE Delete Category", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Delete a category\n\nScope `categories:delete`." } }, { "name": "POST Set Category Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id", "status" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Publish or unpublish a category\n\n", "body": { "mode": "raw", "raw": "{\n \"published\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 The new status.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id", "status" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Publish or unpublish a category\n\n", "body": { "mode": "raw", "raw": "{\n \"published\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"published\": true\n }\n}" } ] } ] }, { "name": "Warehouses", "item": [ { "name": "GET List Warehouses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/warehouses?", "host": [ "{{baseUrl}}" ], "path": [ "warehouses" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "published", "value": "", "disabled": true } ] }, "description": "List warehouses\n\nScope `warehouses:read`." }, "response": [ { "name": "200 A page of warehouses.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/warehouses?", "host": [ "{{baseUrl}}" ], "path": [ "warehouses" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "published", "value": "", "disabled": true } ] }, "description": "List warehouses\n\nScope `warehouses:read`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"string\",\n \"address\": \"string\",\n \"published\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}" } ] }, { "name": "POST Create Warehouse", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/warehouses", "host": [ "{{baseUrl}}" ], "path": [ "warehouses" ] }, "description": "Create a warehouse\n\nScope `warehouses:write`; role permission `configuration.manage_warehouses`. Required: `title`.", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"address\": \"string\",\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Created.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/warehouses", "host": [ "{{baseUrl}}" ], "path": [ "warehouses" ] }, "description": "Create a warehouse\n\nScope `warehouses:write`; role permission `configuration.manage_warehouses`. Required: `title`.", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"address\": \"string\",\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "GET Get Warehouse", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/warehouses/:id", "host": [ "{{baseUrl}}" ], "path": [ "warehouses", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one warehouse, with its custom fields\n\n" }, "response": [ { "name": "200 The warehouse.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/warehouses/:id", "host": [ "{{baseUrl}}" ], "path": [ "warehouses", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one warehouse, with its custom fields\n\n" }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"title\": \"string\",\n \"address\": \"string\",\n \"published\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\",\n \"custom_fields\": {}\n }\n}" } ] }, { "name": "PATCH Update Warehouse", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/warehouses/:id", "host": [ "{{baseUrl}}" ], "path": [ "warehouses", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Update a warehouse\n\n", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"address\": \"string\",\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 Done.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/warehouses/:id", "host": [ "{{baseUrl}}" ], "path": [ "warehouses", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Update a warehouse\n\n", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"address\": \"string\",\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "DELETE Delete Warehouse", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/warehouses/:id", "host": [ "{{baseUrl}}" ], "path": [ "warehouses", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Delete a warehouse\n\nScope `warehouses:delete`." } }, { "name": "POST Set Warehouse Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/warehouses/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "warehouses", ":id", "status" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Publish or unpublish a warehouse\n\n", "body": { "mode": "raw", "raw": "{\n \"published\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 The new status.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/warehouses/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "warehouses", ":id", "status" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Publish or unpublish a warehouse\n\n", "body": { "mode": "raw", "raw": "{\n \"published\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"published\": true\n }\n}" } ] }, { "name": "GET List Warehouse Inventory", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/warehouses/:id/inventory?", "host": [ "{{baseUrl}}" ], "path": [ "warehouses", ":id", "inventory" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true } ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Items held in one warehouse\n\nScope `warehouses:read`; role permission `warehouses.view`; needs the Warehouse Overview app." }, "response": [ { "name": "200 A page of items.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/warehouses/:id/inventory?", "host": [ "{{baseUrl}}" ], "path": [ "warehouses", ":id", "inventory" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true } ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Items held in one warehouse\n\nScope `warehouses:read`; role permission `warehouses.view`; needs the Warehouse Overview app." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"string\",\n \"alias\": \"string\",\n \"item_type\": \"asset\",\n \"sku\": \"string\",\n \"barcode\": \"string\",\n \"serial_number\": \"string\",\n \"category_id\": 1,\n \"category_title\": \"string\",\n \"warehouse_id\": 1,\n \"warehouse_title\": \"string\",\n \"unit_id\": 1,\n \"unit_title\": \"string\",\n \"unit_code\": \"string\",\n \"stock_quantity\": 1.5,\n \"unit_price\": 1.5,\n \"low_stock_threshold\": 1.5,\n \"weight\": 1.5,\n \"weight_unit\": \"string\",\n \"track_weight\": true,\n \"description\": \"string\",\n \"image\": \"string\",\n \"state\": 1,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}" } ] } ] }, { "name": "Recipients", "item": [ { "name": "GET List Recipients", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipients?", "host": [ "{{baseUrl}}" ], "path": [ "recipients" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "published", "value": "", "disabled": true } ] }, "description": "List recipients (people items are checked out to)\n\nScope `recipients:read`." }, "response": [ { "name": "200 A page of recipients.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipients?", "host": [ "{{baseUrl}}" ], "path": [ "recipients" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "published", "value": "", "disabled": true } ] }, "description": "List recipients (people items are checked out to)\n\nScope `recipients:read`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"string\",\n \"email\": \"string\",\n \"department\": \"string\",\n \"published\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}" } ] }, { "name": "POST Create Recipient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipients", "host": [ "{{baseUrl}}" ], "path": [ "recipients" ] }, "description": "Create a recipient\n\nScope `recipients:write`; role permission `configuration.manage_recipients`. Required: `name`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"user@example.com\",\n \"department\": \"string\",\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Created.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipients", "host": [ "{{baseUrl}}" ], "path": [ "recipients" ] }, "description": "Create a recipient\n\nScope `recipients:write`; role permission `configuration.manage_recipients`. Required: `name`.", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"user@example.com\",\n \"department\": \"string\",\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "GET Get Recipient", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipients/:id", "host": [ "{{baseUrl}}" ], "path": [ "recipients", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one recipient, with its custom fields\n\n" }, "response": [ { "name": "200 The recipient.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipients/:id", "host": [ "{{baseUrl}}" ], "path": [ "recipients", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one recipient, with its custom fields\n\n" }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"name\": \"string\",\n \"email\": \"string\",\n \"department\": \"string\",\n \"published\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\",\n \"custom_fields\": {}\n }\n}" } ] }, { "name": "PATCH Update Recipient", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipients/:id", "host": [ "{{baseUrl}}" ], "path": [ "recipients", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Update a recipient\n\n", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"user@example.com\",\n \"department\": \"string\",\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 Done.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipients/:id", "host": [ "{{baseUrl}}" ], "path": [ "recipients", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Update a recipient\n\n", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"user@example.com\",\n \"department\": \"string\",\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "DELETE Delete Recipient", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/recipients/:id", "host": [ "{{baseUrl}}" ], "path": [ "recipients", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Delete a recipient\n\nScope `recipients:delete`." } }, { "name": "POST Set Recipient Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipients/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "recipients", ":id", "status" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Publish or unpublish a recipient\n\n", "body": { "mode": "raw", "raw": "{\n \"published\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 The new status.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipients/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "recipients", ":id", "status" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Publish or unpublish a recipient\n\n", "body": { "mode": "raw", "raw": "{\n \"published\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"published\": true\n }\n}" } ] } ] }, { "name": "Units", "item": [ { "name": "GET List Units", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units?", "host": [ "{{baseUrl}}" ], "path": [ "units" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "published", "value": "", "disabled": true } ] }, "description": "List units of measurement\n\nScope `units:read`." }, "response": [ { "name": "200 A page of units.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units?", "host": [ "{{baseUrl}}" ], "path": [ "units" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "published", "value": "", "disabled": true } ] }, "description": "List units of measurement\n\nScope `units:read`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"string\",\n \"code\": \"string\",\n \"base_unit_id\": 1,\n \"operator\": \"*\",\n \"operation_value\": 1.5,\n \"published\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}" } ] }, { "name": "POST Create Unit", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units", "host": [ "{{baseUrl}}" ], "path": [ "units" ] }, "description": "Create a unit\n\nScope `units:write`; role permission `configuration.manage_units`; needs the Units app. Required: `title`, `code`.", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"code\": \"string\",\n \"base_unit_id\": 1,\n \"operator\": \"*\",\n \"operation_value\": 1.5,\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Created.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units", "host": [ "{{baseUrl}}" ], "path": [ "units" ] }, "description": "Create a unit\n\nScope `units:write`; role permission `configuration.manage_units`; needs the Units app. Required: `title`, `code`.", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"code\": \"string\",\n \"base_unit_id\": 1,\n \"operator\": \"*\",\n \"operation_value\": 1.5,\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "GET Get Unit", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one unit\n\n" }, "response": [ { "name": "200 The unit.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one unit\n\n" }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"title\": \"string\",\n \"code\": \"string\",\n \"base_unit_id\": 1,\n \"operator\": \"*\",\n \"operation_value\": 1.5,\n \"published\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n}" } ] }, { "name": "PATCH Update Unit", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Update a unit\n\n", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"code\": \"string\",\n \"base_unit_id\": 1,\n \"operator\": \"*\",\n \"operation_value\": 1.5,\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 Done.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Update a unit\n\n", "body": { "mode": "raw", "raw": "{\n \"title\": \"string\",\n \"code\": \"string\",\n \"base_unit_id\": 1,\n \"operator\": \"*\",\n \"operation_value\": 1.5,\n \"published\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "DELETE Delete Unit", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/units/:id", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Delete a unit\n\nScope `units:delete`." } }, { "name": "POST Set Unit Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id", "status" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Publish or unpublish a unit\n\n", "body": { "mode": "raw", "raw": "{\n \"published\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 The new status.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id", "status" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Publish or unpublish a unit\n\n", "body": { "mode": "raw", "raw": "{\n \"published\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"published\": true\n }\n}" } ] }, { "name": "GET Get Unit Conversion Chain", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:id/conversion-chain", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id", "conversion-chain" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "The chain of conversions from a unit to its base unit\n\n" }, "response": [ { "name": "200 The chain, from this unit to the base.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/units/:id/conversion-chain", "host": [ "{{baseUrl}}" ], "path": [ "units", ":id", "conversion-chain" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "The chain of conversions from a unit to its base unit\n\n" }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {}\n ]\n}" } ] } ] }, { "name": "Stock movements", "item": [ { "name": "GET List Stock Movement Types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock-movement-types", "host": [ "{{baseUrl}}" ], "path": [ "stock-movement-types" ] }, "description": "The movement types the token owner may record\n\nScope `stock:read`." }, "response": [ { "name": "200 Value / label pairs.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock-movement-types", "host": [ "{{baseUrl}}" ], "path": [ "stock-movement-types" ] }, "description": "The movement types the token owner may record\n\nScope `stock:read`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"value\": \"string\",\n \"label\": \"string\"\n }\n ]\n}" } ] }, { "name": "GET List Stock Movements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock-movements?", "host": [ "{{baseUrl}}" ], "path": [ "stock-movements" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "movement_type", "value": "", "disabled": true }, { "key": "is_draft", "value": "", "disabled": true }, { "key": "warehouse_id", "value": "", "disabled": true }, { "key": "recipient_id", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "List stock movements\n\nScope `stock:read`; the owner needs at least one movement permission." }, "response": [ { "name": "200 A page of movements.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock-movements?", "host": [ "{{baseUrl}}" ], "path": [ "stock-movements" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "movement_type", "value": "", "disabled": true }, { "key": "is_draft", "value": "", "disabled": true }, { "key": "warehouse_id", "value": "", "disabled": true }, { "key": "recipient_id", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "List stock movements\n\nScope `stock:read`; the owner needs at least one movement permission." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"batch_id\": \"string\",\n \"reference\": \"string\",\n \"movement_date\": \"2026-01-01\",\n \"movement_type\": \"check_in\",\n \"recipient_id\": 1,\n \"warehouse_id\": 1,\n \"details\": \"string\",\n \"is_draft\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"created_by\": 1,\n \"modified\": \"2026-01-01T12:00:00Z\",\n \"warehouse_title\": \"string\",\n \"recipient_name\": \"string\",\n \"created_by_name\": \"string\",\n \"items_count\": 1\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}" } ] }, { "name": "POST Create Stock Movement", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock-movements", "host": [ "{{baseUrl}}" ], "path": [ "stock-movements" ] }, "description": "Record a check-in, check-out, stock addition or stock removal\n\nScope `stock:write`, plus the owner's role permission for the type (`transactions.checkin`,\n`checkout`, `add_stock`, `remove_stock`).\n\nWith `is_draft: false` the movement is finalized at once: stock changes and ledger rows are\nwritten. With `is_draft: true` (the default) nothing changes until\n`POST /stock-movements/{id}/finalize`.\n\nRules, the same as in Next Inventory itself: `check_out` needs a `recipient_id`;\n`check_out` / `remove_stock` are refused (400) when an item has less stock than requested;\n`check_in` / `check_out` take assets only, `add_stock` / `remove_stock` consumables and\nsellables only.", "body": { "mode": "raw", "raw": "{\n \"movement_type\": \"add_stock\",\n \"is_draft\": false,\n \"movement_date\": \"2026-11-11\",\n \"warehouse_id\": 1,\n \"reference\": \"PO-1042\",\n \"items\": [\n {\n \"item_id\": 17,\n \"quantity\": 40,\n \"cost_per_unit\": 3.2\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Created.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock-movements", "host": [ "{{baseUrl}}" ], "path": [ "stock-movements" ] }, "description": "Record a check-in, check-out, stock addition or stock removal\n\nScope `stock:write`, plus the owner's role permission for the type (`transactions.checkin`,\n`checkout`, `add_stock`, `remove_stock`).\n\nWith `is_draft: false` the movement is finalized at once: stock changes and ledger rows are\nwritten. With `is_draft: true` (the default) nothing changes until\n`POST /stock-movements/{id}/finalize`.\n\nRules, the same as in Next Inventory itself: `check_out` needs a `recipient_id`;\n`check_out` / `remove_stock` are refused (400) when an item has less stock than requested;\n`check_in` / `check_out` take assets only, `add_stock` / `remove_stock` consumables and\nsellables only.", "body": { "mode": "raw", "raw": "{\n \"movement_type\": \"add_stock\",\n \"is_draft\": false,\n \"movement_date\": \"2026-11-11\",\n \"warehouse_id\": 1,\n \"reference\": \"PO-1042\",\n \"items\": [\n {\n \"item_id\": 17,\n \"quantity\": 40,\n \"cost_per_unit\": 3.2\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "GET Get Stock Movement", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock-movements/:id", "host": [ "{{baseUrl}}" ], "path": [ "stock-movements", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one movement with its lines\n\n" }, "response": [ { "name": "200 The movement.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock-movements/:id", "host": [ "{{baseUrl}}" ], "path": [ "stock-movements", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one movement with its lines\n\n" }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"batch_id\": \"string\",\n \"reference\": \"string\",\n \"movement_date\": \"2026-01-01\",\n \"movement_type\": \"check_in\",\n \"recipient_id\": 1,\n \"warehouse_id\": 1,\n \"details\": \"string\",\n \"is_draft\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"created_by\": 1,\n \"modified\": \"2026-01-01T12:00:00Z\",\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1,\n \"item_title\": \"string\",\n \"sku\": \"string\",\n \"quantity\": 1.5,\n \"weight\": 1.5,\n \"weight_unit\": \"string\",\n \"cost_per_unit\": 1.5\n }\n ]\n }\n}" } ] }, { "name": "DELETE Delete Stock Movement", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/stock-movements/:id", "host": [ "{{baseUrl}}" ], "path": [ "stock-movements", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Delete a DRAFT movement\n\nScope `stock:write`. A finalized movement cannot be deleted (400): it is part of the audit trail." } }, { "name": "POST Finalize Stock Movement", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/stock-movements/:id/finalize", "host": [ "{{baseUrl}}" ], "path": [ "stock-movements", ":id", "finalize" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Finalize a draft movement (applies the stock change)\n\nScope `stock:write`. 400 when already finalized or when stock is insufficient." }, "response": [ { "name": "200 Done.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/stock-movements/:id/finalize", "host": [ "{{baseUrl}}" ], "path": [ "stock-movements", ":id", "finalize" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Finalize a draft movement (applies the stock change)\n\nScope `stock:write`. 400 when already finalized or when stock is insufficient." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] } ] }, { "name": "Transactions", "item": [ { "name": "GET List Transactions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions?", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "item_id", "value": "", "disabled": true }, { "key": "transaction_type", "value": "", "disabled": true }, { "key": "created_by", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "The ledger — every stock change, newest first\n\nScope `transactions:read`; role permission `transactions.view`." }, "response": [ { "name": "200 A page of ledger rows.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions?", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "item_id", "value": "", "disabled": true }, { "key": "transaction_type", "value": "", "disabled": true }, { "key": "created_by", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "The ledger — every stock change, newest first\n\nScope `transactions:read`; role permission `transactions.view`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"item_id\": 1,\n \"item_title\": \"string\",\n \"item_sku\": \"string\",\n \"transaction_type\": \"string\",\n \"quantity_change\": 1.5,\n \"new_quantity\": 1.5,\n \"transaction_unit_id\": 1,\n \"original_quantity\": 1.5,\n \"cost_per_unit\": 1.5,\n \"total_cost\": 1.5,\n \"batch_id\": \"string\",\n \"recipient_id\": 1,\n \"recipient\": \"string\",\n \"reason\": \"string\",\n \"created_by\": 1,\n \"created_by_name\": \"string\",\n \"created\": \"2026-01-01T12:00:00Z\"\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}" } ] }, { "name": "GET Get Transaction", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:id", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one ledger row\n\n" }, "response": [ { "name": "200 The transaction.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:id", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one ledger row\n\n" }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"item_id\": 1,\n \"item_title\": \"string\",\n \"item_sku\": \"string\",\n \"transaction_type\": \"string\",\n \"quantity_change\": 1.5,\n \"new_quantity\": 1.5,\n \"transaction_unit_id\": 1,\n \"original_quantity\": 1.5,\n \"cost_per_unit\": 1.5,\n \"total_cost\": 1.5,\n \"batch_id\": \"string\",\n \"recipient_id\": 1,\n \"recipient\": \"string\",\n \"reason\": \"string\",\n \"created_by\": 1,\n \"created_by_name\": \"string\",\n \"created\": \"2026-01-01T12:00:00Z\"\n }\n}" } ] } ] }, { "name": "Transfers", "item": [ { "name": "GET List Transfers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transfers?", "host": [ "{{baseUrl}}" ], "path": [ "transfers" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "is_draft", "value": "", "disabled": true }, { "key": "from_warehouse_id", "value": "", "disabled": true }, { "key": "to_warehouse_id", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "List warehouse transfers\n\nScope `transfers:read`; role permission `inventory.manage_transfers`; needs the Transfers app." }, "response": [ { "name": "200 A page of transfers.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transfers?", "host": [ "{{baseUrl}}" ], "path": [ "transfers" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "is_draft", "value": "", "disabled": true }, { "key": "from_warehouse_id", "value": "", "disabled": true }, { "key": "to_warehouse_id", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "List warehouse transfers\n\nScope `transfers:read`; role permission `inventory.manage_transfers`; needs the Transfers app." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"reference\": \"string\",\n \"transfer_date\": \"2026-01-01\",\n \"from_warehouse_id\": 1,\n \"from_warehouse_title\": \"string\",\n \"to_warehouse_id\": 1,\n \"to_warehouse_title\": \"string\",\n \"details\": \"string\",\n \"is_draft\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"created_by\": 1,\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}" } ] }, { "name": "POST Create Transfer", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transfers", "host": [ "{{baseUrl}}" ], "path": [ "transfers" ] }, "description": "Move stock between two warehouses\n\nScope `transfers:write`. `is_draft: false` finalizes at once.", "body": { "mode": "raw", "raw": "{\n \"transfer_date\": \"2026-11-11\",\n \"from_warehouse_id\": 1,\n \"to_warehouse_id\": 2,\n \"is_draft\": false,\n \"items\": [\n {\n \"item_id\": 17,\n \"quantity\": 5\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Created.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transfers", "host": [ "{{baseUrl}}" ], "path": [ "transfers" ] }, "description": "Move stock between two warehouses\n\nScope `transfers:write`. `is_draft: false` finalizes at once.", "body": { "mode": "raw", "raw": "{\n \"transfer_date\": \"2026-11-11\",\n \"from_warehouse_id\": 1,\n \"to_warehouse_id\": 2,\n \"is_draft\": false,\n \"items\": [\n {\n \"item_id\": 17,\n \"quantity\": 5\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "GET Get Transfer", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transfers/:id", "host": [ "{{baseUrl}}" ], "path": [ "transfers", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one transfer with its lines\n\n" }, "response": [ { "name": "200 The transfer.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transfers/:id", "host": [ "{{baseUrl}}" ], "path": [ "transfers", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one transfer with its lines\n\n" }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"reference\": \"string\",\n \"transfer_date\": \"2026-01-01\",\n \"from_warehouse_id\": 1,\n \"from_warehouse_title\": \"string\",\n \"to_warehouse_id\": 1,\n \"to_warehouse_title\": \"string\",\n \"details\": \"string\",\n \"is_draft\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"created_by\": 1,\n \"modified\": \"2026-01-01T12:00:00Z\",\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1,\n \"item_title\": \"string\",\n \"sku\": \"string\",\n \"quantity\": 1.5\n }\n ]\n }\n}" } ] }, { "name": "DELETE Delete Transfer", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/transfers/:id", "host": [ "{{baseUrl}}" ], "path": [ "transfers", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Delete a DRAFT transfer\n\n" } }, { "name": "POST Finalize Transfer", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/transfers/:id/finalize", "host": [ "{{baseUrl}}" ], "path": [ "transfers", ":id", "finalize" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Finalize a draft transfer\n\n" }, "response": [ { "name": "200 Done.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/transfers/:id/finalize", "host": [ "{{baseUrl}}" ], "path": [ "transfers", ":id", "finalize" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Finalize a draft transfer\n\n" }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] } ] }, { "name": "Adjustments", "item": [ { "name": "GET List Adjustment Types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/adjustment-types", "host": [ "{{baseUrl}}" ], "path": [ "adjustment-types" ] }, "description": "Adjustment types (addition, damage, subtraction)\n\nScope `adjustments:read`." }, "response": [ { "name": "200 Value / label pairs.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/adjustment-types", "host": [ "{{baseUrl}}" ], "path": [ "adjustment-types" ] }, "description": "Adjustment types (addition, damage, subtraction)\n\nScope `adjustments:read`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"value\": \"string\",\n \"label\": \"string\"\n }\n ]\n}" } ] }, { "name": "GET List Adjustments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/adjustments?", "host": [ "{{baseUrl}}" ], "path": [ "adjustments" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "is_draft", "value": "", "disabled": true }, { "key": "adjustment_type", "value": "", "disabled": true }, { "key": "warehouse_id", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "List stock adjustments\n\nScope `adjustments:read`; role permission `inventory.manage_adjustments`; needs the Adjustments app." }, "response": [ { "name": "200 A page of adjustments.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/adjustments?", "host": [ "{{baseUrl}}" ], "path": [ "adjustments" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "is_draft", "value": "", "disabled": true }, { "key": "adjustment_type", "value": "", "disabled": true }, { "key": "warehouse_id", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "List stock adjustments\n\nScope `adjustments:read`; role permission `inventory.manage_adjustments`; needs the Adjustments app." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": 1,\n \"reference\": \"string\",\n \"adjustment_date\": \"2026-01-01\",\n \"adjustment_type\": \"addition\",\n \"warehouse_id\": 1,\n \"warehouse_title\": \"string\",\n \"details\": \"string\",\n \"is_draft\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"created_by\": 1,\n \"modified\": \"2026-01-01T12:00:00Z\"\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}" } ] }, { "name": "POST Create Adjustment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/adjustments", "host": [ "{{baseUrl}}" ], "path": [ "adjustments" ] }, "description": "Record found, damaged or lost stock\n\nScope `adjustments:write`. `is_draft: false` finalizes at once.", "body": { "mode": "raw", "raw": "{\n \"adjustment_date\": \"2026-11-11\",\n \"adjustment_type\": \"damage\",\n \"warehouse_id\": 1,\n \"details\": \"Water damage\",\n \"is_draft\": false,\n \"items\": [\n {\n \"item_id\": 17,\n \"quantity\": 2\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "201 Created.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/adjustments", "host": [ "{{baseUrl}}" ], "path": [ "adjustments" ] }, "description": "Record found, damaged or lost stock\n\nScope `adjustments:write`. `is_draft: false` finalizes at once.", "body": { "mode": "raw", "raw": "{\n \"adjustment_date\": \"2026-11-11\",\n \"adjustment_type\": \"damage\",\n \"warehouse_id\": 1,\n \"details\": \"Water damage\",\n \"is_draft\": false,\n \"items\": [\n {\n \"item_id\": 17,\n \"quantity\": 2\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "201", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] }, { "name": "GET Get Adjustment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/adjustments/:id", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one adjustment with its lines\n\n" }, "response": [ { "name": "200 The adjustment.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/adjustments/:id", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Get one adjustment with its lines\n\n" }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1,\n \"reference\": \"string\",\n \"adjustment_date\": \"2026-01-01\",\n \"adjustment_type\": \"addition\",\n \"warehouse_id\": 1,\n \"warehouse_title\": \"string\",\n \"details\": \"string\",\n \"is_draft\": true,\n \"created\": \"2026-01-01T12:00:00Z\",\n \"created_by\": 1,\n \"modified\": \"2026-01-01T12:00:00Z\",\n \"items\": [\n {\n \"id\": 1,\n \"item_id\": 1,\n \"item_title\": \"string\",\n \"sku\": \"string\",\n \"quantity\": 1.5\n }\n ]\n }\n}" } ] }, { "name": "DELETE Delete Adjustment", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/adjustments/:id", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":id" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Delete a DRAFT adjustment\n\n" } }, { "name": "POST Finalize Adjustment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/adjustments/:id/finalize", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":id", "finalize" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Finalize a draft adjustment\n\n" }, "response": [ { "name": "200 Done.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "" }, { "key": "If-Match", "value": "" } ], "url": { "raw": "{{baseUrl}}/adjustments/:id/finalize", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":id", "finalize" ], "variable": [ { "key": "id", "description": "(min 1)" } ] }, "description": "Finalize a draft adjustment\n\n" }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": 1\n }\n}" } ] } ] }, { "name": "Reports", "item": [ { "name": "GET Report Stock Valuation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/stock-valuation", "host": [ "{{baseUrl}}" ], "path": [ "reports", "stock-valuation" ] }, "description": "Stock value by category, with totals\n\nScope `reports:read`." }, "response": [ { "name": "200 The report, in the same shape the Reports screen reads. Its structure may grow between minor versions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/stock-valuation", "host": [ "{{baseUrl}}" ], "path": [ "reports", "stock-valuation" ] }, "description": "Stock value by category, with totals\n\nScope `reports:read`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"string\"\n}" } ] }, { "name": "GET Report Low Stock", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/low-stock", "host": [ "{{baseUrl}}" ], "path": [ "reports", "low-stock" ] }, "description": "Items at or below their low-stock threshold\n\nScope `reports:read`." }, "response": [ { "name": "200 The report, in the same shape the Reports screen reads. Its structure may grow between minor versions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/low-stock", "host": [ "{{baseUrl}}" ], "path": [ "reports", "low-stock" ] }, "description": "Items at or below their low-stock threshold\n\nScope `reports:read`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"string\"\n}" } ] }, { "name": "GET Report Stock By Warehouse", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/stock-by-warehouse", "host": [ "{{baseUrl}}" ], "path": [ "reports", "stock-by-warehouse" ] }, "description": "Quantity and value per warehouse\n\nScope `reports:read`." }, "response": [ { "name": "200 The report, in the same shape the Reports screen reads. Its structure may grow between minor versions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/stock-by-warehouse", "host": [ "{{baseUrl}}" ], "path": [ "reports", "stock-by-warehouse" ] }, "description": "Quantity and value per warehouse\n\nScope `reports:read`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"string\"\n}" } ] }, { "name": "GET Report Stock By Type", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/stock-by-type", "host": [ "{{baseUrl}}" ], "path": [ "reports", "stock-by-type" ] }, "description": "Quantity and value per item type\n\nScope `reports:read`; needs the Reports app." }, "response": [ { "name": "200 The report, in the same shape the Reports screen reads. Its structure may grow between minor versions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/stock-by-type", "host": [ "{{baseUrl}}" ], "path": [ "reports", "stock-by-type" ] }, "description": "Quantity and value per item type\n\nScope `reports:read`; needs the Reports app." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"string\"\n}" } ] }, { "name": "GET Report Stock Movement", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/stock-movement?", "host": [ "{{baseUrl}}" ], "path": [ "reports", "stock-movement" ], "query": [ { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "Stock in and out per day\n\nScope `reports:read`; needs the Reports app." }, "response": [ { "name": "200 The report, in the same shape the Reports screen reads. Its structure may grow between minor versions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/stock-movement?", "host": [ "{{baseUrl}}" ], "path": [ "reports", "stock-movement" ], "query": [ { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "Stock in and out per day\n\nScope `reports:read`; needs the Reports app." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"string\"\n}" } ] }, { "name": "GET Report Transaction Trends", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/transaction-trends?", "host": [ "{{baseUrl}}" ], "path": [ "reports", "transaction-trends" ], "query": [ { "key": "period", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "Transaction counts by type over time\n\nScope `reports:read`; needs the Reports app." }, "response": [ { "name": "200 The report, in the same shape the Reports screen reads. Its structure may grow between minor versions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/transaction-trends?", "host": [ "{{baseUrl}}" ], "path": [ "reports", "transaction-trends" ], "query": [ { "key": "period", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "Transaction counts by type over time\n\nScope `reports:read`; needs the Reports app." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"string\"\n}" } ] }, { "name": "GET Report Kpi Trends", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/kpi-trends?", "host": [ "{{baseUrl}}" ], "path": [ "reports", "kpi-trends" ], "query": [ { "key": "days", "value": "", "disabled": true } ] }, "description": "Dashboard KPIs compared with the previous period\n\nScope `reports:read`." }, "response": [ { "name": "200 The report, in the same shape the Reports screen reads. Its structure may grow between minor versions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/kpi-trends?", "host": [ "{{baseUrl}}" ], "path": [ "reports", "kpi-trends" ], "query": [ { "key": "days", "value": "", "disabled": true } ] }, "description": "Dashboard KPIs compared with the previous period\n\nScope `reports:read`." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"string\"\n}" } ] }, { "name": "GET Report Top Performers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/top-performers?", "host": [ "{{baseUrl}}" ], "path": [ "reports", "top-performers" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "days", "value": "", "disabled": true }, { "key": "type", "value": "", "disabled": true } ] }, "description": "Most (or least) moved items\n\nScope `reports:read`; needs the Reports app." }, "response": [ { "name": "200 The report, in the same shape the Reports screen reads. Its structure may grow between minor versions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/top-performers?", "host": [ "{{baseUrl}}" ], "path": [ "reports", "top-performers" ], "query": [ { "key": "limit", "value": "", "disabled": true }, { "key": "days", "value": "", "disabled": true }, { "key": "type", "value": "", "disabled": true } ] }, "description": "Most (or least) moved items\n\nScope `reports:read`; needs the Reports app." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"string\"\n}" } ] }, { "name": "GET Report Category Drilldown", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/category-drilldown?category_id=", "host": [ "{{baseUrl}}" ], "path": [ "reports", "category-drilldown" ], "query": [ { "key": "category_id", "value": "" } ] }, "description": "Items and value inside one category\n\nScope `reports:read`; needs the Reports app." }, "response": [ { "name": "200 The report, in the same shape the Reports screen reads. Its structure may grow between minor versions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/category-drilldown?category_id=", "host": [ "{{baseUrl}}" ], "path": [ "reports", "category-drilldown" ], "query": [ { "key": "category_id", "value": "" } ] }, "description": "Items and value inside one category\n\nScope `reports:read`; needs the Reports app." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"string\"\n}" } ] }, { "name": "GET Report Cogs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/cogs?", "host": [ "{{baseUrl}}" ], "path": [ "reports", "cogs" ], "query": [ { "key": "period", "value": "", "disabled": true } ] }, "description": "Cost of goods sold (FIFO/LIFO)\n\nScope `reports:read`; needs the Reports app." }, "response": [ { "name": "200 The report, in the same shape the Reports screen reads. Its structure may grow between minor versions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/cogs?", "host": [ "{{baseUrl}}" ], "path": [ "reports", "cogs" ], "query": [ { "key": "period", "value": "", "disabled": true } ] }, "description": "Cost of goods sold (FIFO/LIFO)\n\nScope `reports:read`; needs the Reports app." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"string\"\n}" } ] }, { "name": "GET Report Inventory Aging", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/inventory-aging", "host": [ "{{baseUrl}}" ], "path": [ "reports", "inventory-aging" ] }, "description": "Age of stock still held, by cost layer\n\nScope `reports:read`; needs the Reports app." }, "response": [ { "name": "200 The report, in the same shape the Reports screen reads. Its structure may grow between minor versions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/inventory-aging", "host": [ "{{baseUrl}}" ], "path": [ "reports", "inventory-aging" ] }, "description": "Age of stock still held, by cost layer\n\nScope `reports:read`; needs the Reports app." }, "status": "200", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"string\"\n}" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiToken}}", "type": "string" } ] } }