Inventory List
View import/export or transfer information of products in the warehouse.
API Endpoint
| URL |
{base url}/api/StockTransfer/ProductTransfersList |
| Method |
POST |
| Authorization |
Bearer Token |
| Content-Type |
application/json |
Request Headers
| Parameter |
Type |
Required |
Description |
| APIKEY |
string |
true |
System key code |
Request Parameters
| Parameter |
Type |
Required |
Description |
| Limit |
integer |
true |
Number of records to retrieve |
| LoadIndex |
integer |
true |
The starting index for the data to retrieve |
| Active |
boolean |
false |
Status of the records (True = active, False = inactive) |
| Sortby |
string |
false |
Field to sort by (e.g., createdate) |
| SortType |
string |
false |
Sorting direction (asc = ascending, desc = descending) |
| WarehouseId |
string |
false |
Warehouse ID |
| From_Date |
string |
true |
Filter data from the specified date (format: dd-mm-yyyy, Gregorian calendar) |
| To_Date |
string |
true |
Filter data up to the specified date (format: dd-mm-yyyy, Gregorian calendar) |
| DocumentNumber |
string |
false |
Document number |
| ReferenceNumber |
string |
false |
Reference number |
| Remark |
string |
false |
Search within remarks |
| TransferType |
string |
false |
Filter by operation type
- IN = Inbound
- OUT = Outbound
- TF = Transfer between
|
| TransStatus |
string |
false |
transfer status
- NEW = New transfer
- PCS = In Process
- CMP = Completed
- CAN = Canceled
|
Request JSON Example
{
"Limit": 10,
"LoadIndex": 1,
"Active": true,
"Sortby": "",
"SortType": "",
"WarehouseId": "",
"From_Date": "01-10-2024",
"To_Date": "31-12-2024",
"DocumentNumber": "",
"ReferenceNumber": "",
"Remark": "",
"TransferType": ""
}
Response Parameters
| Parameter |
Type |
Description |
| Id |
integer |
Error status (0 = no error) |
| Success |
boolean |
Status of the request |
| Message |
string |
Response message |
| RequestId |
string |
Reference ID for the request |
| Size |
integer |
Number of records returned |
| Data |
object |
Transfer data |
Data
| Parameter |
Type |
Description |
| Id |
string |
ID |
| DocNo |
string |
Document number |
| TransType |
string |
Transfer type |
| DocDate |
string |
Document date |
| DocPoNo |
string |
Purchase/Order document |
| DocRefNo |
string |
Reference document |
| DueDate |
string |
Operation date |
| Brand |
boolean |
Brand |
| TransferFrom |
string |
Source warehouse |
| TransferTo |
string |
Destination warehouse |
| TransferRef |
string |
Reference warehouse |
| Remark |
string |
Remarks |
| TransStatus |
string |
Transaction status
- NEW = Waiting for verification
- CAN = Canceled
- PCS = In progress
- CMP = Complete or Received
|
| TransStatusDesc |
string |
Transaction status description |
| Tag |
string |
Tag |
| UpdateDate |
string |
Last updated time |
| CreateDate |
string |
Creation time |
| TransferItems |
object |
Details of transfer items |
TransferItems
| Parameter |
Type |
Description |
| ItemId |
string |
Transfer item ID |
| SkuId |
string |
SKU ID |
| Sku |
string |
SKU code |
| Barcode |
string |
Barcode |
| Qty |
integer |
Quantity |
| QtyReceived |
integer |
Quantity received |
| QtyDamage |
integer |
Quantity damaged |
| QtyReject |
integer |
Quantity rejected |
| QtyLost |
integer |
Quantity lost/missing |
| MfgDate |
string |
Manufacturing date |
| ExpDate |
string |
Expiration date |
| CartonId |
string |
Carton ID |
| RefId |
string |
Reference ID |
| Remark |
string |
Remarks |
| WarehouseId |
string |
Warehouse ID |
| Tag |
string |
Tag |
Response JSON Example
{
"Id": 0,
"Success": true,
"Message": "SUCCESS",
"RequestId": "B127AFA8-26AE-4F1B-94A9-DCC12ACAB3B4",
"Size": 1,
"Data": [
{
"Id": "1E77E6F1-843A-4D58-A680-A940979DEDA7",
"DocNo": "test32564",
"DocType": null,
"TransType": "IN",
"DocDate": "2024-12-06T00:00:00",
"DocPoNo": "test32564",
"DocRefNo": null,
"DueDate": "2024-12-10T00:00:00",
"Brand": null,
"TransferFrom": null,
"TransferTo": null,
"TransferRef": null,
"Remark": null,
"ShopId": null,
"TransStatus": "PCS",
"TransStatusDesc": "Currently accepting",
"Tag": null,
"UpdateDate": "2024-12-06T17:36:11.3204356",
"CreateDate": "2024-12-06T09:19:01.5054621",
"TransferItems": [
{
"ItemId": "20A87C41-5679-47CE-8C01-BA660FD2B40D",
"SkuId": "09F7E469-AFAA-4849-8C5A-357C500344B8",
"Sku": "1122000166582",
"Barcode": "1122000166582",
"Qty": 6,
"QtyReceived": null,
"QtyDamage": null,
"QtyReject": null,
"QtyLost": null,
"MfgDate": null,
"ExpDate": null,
"CartonId": null,
"RefId": null,
"Remark": null,
"WarehouseId": null,
"Tag": null
}
]
}
]
}