Base URL
https://{tenant}.logzi.com/api/stock_management/
Every request returns a JSON response. On success result.code == 1, on error result.code == 0.
stock_management/save endpoint is not available via the API — stock movements are created through the booking, outgoing and transmission modules.
/api/stock_management/list
Paginated retrieval of the stock movement list, with filtering options.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset |
int | Pagination offset (default: 0) | |
list_condition |
array | Array of filtering conditions |
Example request
GET /api/stock_management/list?list_offset=0
X-API-KEY: {your_api_key}/api/stock_management/awaiting_list
Paginated list of awaiting (pending) stock movements.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset |
int | Pagination offset (default: 0) | |
list_condition |
array | Array of filtering conditions |
Example request
GET /api/stock_management/awaiting_list?list_offset=0
X-API-KEY: {your_api_key}/api/stock_management/suggest_list
Paginated list of suggested stock movements.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset |
int | Pagination offset (default: 0) | |
list_condition |
array | Array of filtering conditions |
Example request
GET /api/stock_management/suggest_list?list_offset=0
X-API-KEY: {your_api_key}/api/stock_management/review_list
Paginated list of review-required stock movements.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset |
int | Pagination offset (default: 0) | |
list_condition |
array | Array of filtering conditions |
Example request
GET /api/stock_management/review_list?list_offset=0
X-API-KEY: {your_api_key}/api/stock_management/list_receipt_cr
Paginated list of related document cross-references.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset |
int | Pagination offset (default: 0) |
Example request
GET /api/stock_management/list_receipt_cr?list_offset=0
X-API-KEY: {your_api_key}/api/stock_management/list_receipt
Retrieve the list of documents related to a stock movement.
Example request
GET /api/stock_management/list_receipt
X-API-KEY: {your_api_key}/api/stock_management/list_item
List the items of a stock movement.
Example request
GET /api/stock_management/list_item
X-API-KEY: {your_api_key}/api/stock_management/close
Close an open stock movement document.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
receipt_id |
int | Identifier of the stock movement document to close |
Example request
POST /api/stock_management/close
X-API-KEY: {your_api_key}
Content-Type: application/json
{
"data": {
"receipt_id": 15
}
}Example response
{
"result": { "code": 1, "message": "success" },
"data": {}
}/api/stock_management/download
Download the stock movement document (e.g. in PDF format).
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
receipt_id |
int | Identifier of the document to download | |
file_type |
string | Output format (e.g. pdf, stream) |
Example request
GET /api/stock_management/download?receipt_id=15&file_type=pdf
X-API-KEY: {your_api_key}Example response
{
"result": { "code": 1, "message": "success" },
"data": {
"name": "STOCK-2024-0015.pdf",
"content": "JVBERi0xLjQK..."
}
}Create your account now,
pay later!
