Clients can query the inventory in different level
|
# |
Item |
Description |
|
1 |
Request URL |
/api/system/itapi_edi2?edi_code=ITEM_BALANCE_ENQUIRY&user_code={USERCODE} |
|
2 |
Request Method |
POST |
|
3 |
Request Data Format |
XML |
|
4 |
Request Data Encoding |
UTF-8 |
|
5 |
Complete URL Example |
http://www1.jflog.com:8008/WHS_TEST/api/system/itapi_edi2?edi_code=ITEM_BALANCE_ENQUIRY&user_code={USERCODE} |
|
# |
Node with Example |
Explanation |
Max Length |
Remark |
|
1 |
<?xml version=”1.0″ encoding=”UTF-8″?> | |||
|
2 |
<Request> | |||
|
3 |
<RequestID>##REQUEST_ID##</RequestID> |
Request ID. |
20 |
Generated by client. Will return in response message for reference |
|
4 |
<Auth> | |||
|
5 |
<user_code>{USERCODE}</user_code> |
API username |
30 |
Mandatory |
|
6 |
<password>{PASSWORD}</password> |
API Password |
30 |
Mandatory |
|
7 |
</Auth> |
|
|
|
|
8 |
<GroupingLevel> |
|
| |
|
9 |
<Type>ItemNumber</Type> |
Group Type |
Mandatory, Group Type: Customer StockInNumber/ItemNumber/WarehouseLocation/Lot | |
|
10 |
<BalanceDate>2019-12-31T23:59:59+08:00</BalanceDate> |
Balance Date |
Mandatory, with Time zone | |
|
11 |
</GroupingLevel> | |||
|
12 |
<SearchingCriteria> |
|
|
|
|
13 |
<Criteria1>Customer</Criteria1> |
Search Criteria 1 |
Max 10 criteria can apply, can be criteria {1-10} Criteria 1 – Customer | |
|
14 |
<Value1>CUSTCODE</Value1> |
Customer code |
8 |
Value for Criteria1 *Every customer has their own customer code in WMS system, please consult IT for the customer code |
|
15 |
<Criteria2>Warehouse</Criteria2> |
Search Criteria 2 |
Criteria 2 – Warehouse | |
|
16 |
<Value2>WHSCODE</Value2> |
Warehouse code |
8 |
Value for Criteria2 *Please consult IT for the WHS code |
|
17 |
<Criteria3>StockInNumber</Criteria3> |
Search Criteria 3 |
|
Criteria 3 – Stock In Number |
|
18 |
<Value3>STOCKINNO</Value3> |
Stock in number |
30 |
|
|
|
<Criteria4>ItemNumber</Criteria4> |
Search Criteria 4 |
|
Criteria 4 – Item Number |
|
|
<Value4>ITEM_NO</Value4> |
Item Number |
30 |
|
|
|
<Criteria5>ClientItemNumber</Criteria5> |
Search Criteria 5 |
|
Criteria 5 – Client Item Number |
|
|
<Value5>CLIENT_ITEM_NO</Value5> |
Client Item Number |
30 |
|
|
|
<Criteria6>PONumber</Criteria6> |
Search Criteria 6 |
|
Criteria 6 – PO Number |
|
|
<Value6>PO_NO</Value6> |
PO Number |
50 |
|
|
|
<Criteria7>LotStatus</Criteria7> |
Search Criteria 7 |
|
Criteria 7 – Stock/Lot Status |
|
|
<Value7>STATUS_CODE</Value7> |
Status Code |
8 |
*Please consult IT for the status code |
|
|
<Criteria8>WarehouseLocation</Criteria8> |
Search Criteria 8 |
|
Criteria 8 – Location Code |
|
|
<Value8>LOCATAION_CODE</Value8> |
Location Code |
8 |
|
|
|
<Criteria9>ReceiveDateFrom</Criteria9> |
Search Criteria 9 |
|
Criteria 9 – Transaction Date from |
|
|
<Value9>FullDateTime</Value9> |
From Date |
|
*Example: 1999-01-01 00:00:00 |
|
|
<Criteria10>ReceiveDateTo</Criteria10> |
Search Criteria 10 |
|
Criteria 10 –Transaction Date to |
|
|
<Value10>FullDateTime</Value10> |
To Date |
|
*Example: 2099-12-31 23:59:59 |
|
19 |
</SearchingCriteria> |
|
|
|
|
20 |
</Request> |
|
|
|
|
Note: SearchingCriteria is optional. API will list all caller’s inventory if no SearchingCriteria provided. Filling customer code and warehouse code should fulfill all your needs in general. |
|
# |
Node with Example |
Explanation |
Remark |
|
1 |
<Response> |
|
|
|
2 |
<RequestID>##REQUEST_ID##</RequestID> |
Your Request ID |
|
|
3 |
<ResponseID>WTI11004021</ResponseID> |
Response ID (Gen. by API) |
|
|
4 |
<ResponseDate>2018-11-08T11:54:43+08:00</ResponseDate> |
Response Date |
|
|
5 |
<ResponseStatus>SUCCESS</ResponseStatus> |
Response Status |
SUCCESS , FAIL |
|
6 |
<Inventory> |
| |
|
7 |
<Type>ItemNumber</Type> |
Type of Group |
|
|
8 |
<PKG>200.00</PKG> |
Outer Package Qty. |
|
|
9 |
<InPKG>200.00</InPKG> |
Inner Pcs Qty. |
|
|
10 |
<GrossWeight>0.00</GrossWeight> |
Total Gross Weight |
|
|
11 |
<NetWeight>0.00</NetWeight> |
Total Net Weight |
|
|
12 |
<CBM>0.000</CBM> |
Total CBM |
|
|
13 |
<Customer>Item Owner Name</Customer> |
Item owner name |
|
|
14 |
<ItemNumber>2830</ItemNumber> |
SKU / Item Number |
|
|
15 |
<ClientItemNumber/> |
|
|
|
16 |
<ItemSize/> |
(Item Attribute) Size |
|
|
17 |
<ItemClass/> |
(Item Attribute) Class |
|
|
18 |
<ItemColor/> |
(Item Attribute) Color |
|
|
19 |
<ItemSeason/> |
(Item Attribute) Season |
|
|
20 |
<Length>0.00</Length> |
|
|
|
21 |
<Width>0.00</Width> |
|
|
|
22 |
<Height>0.00</Height> |
|
|
|
23 |
<Description>Item Description / Product Name</Description> |
Item Description |
|
|
24 |
<UnitCurrency>HKD</UnitCurrency> |
Currency of product |
|
|
25 |
<UnitPrice>0.000</UnitPrice> |
Unit Price |
|
|
26 |
<UniqueItemBarcode/> |
UPC barcode |
|
|
27 |
<ProductionCountryCode/> |
Country of origin |
|
|
28 |
</Inventory> |
|
|
|
29 |
<Inventory> |
|
|
|
30 |
<Type>ItemNumber</Type> |
Type of Group |
|
|
31 |
<PKG>199.00</PKG> |
Outer Package Qty. |
|
|
32 |
<InPKG>199.00</InPKG> |
Inner Pcs Qty. |
|
|
33 |
<GrossWeight>0.00</GrossWeight> |
Total Gross Weight |
|
|
34 |
<NetWeight>0.00</NetWeight> |
Total Net Weight |
|
|
35 |
<CBM>0.000</CBM> |
Total CBM |
|
|
36 |
<Customer>Cust Name</Customer> |
Item owner name |
|
|
37 |
<ItemNumber>3246</ItemNumber> |
SKU / Item Number |
|
|
38 |
<ClientItemNumber/> |
|
|
|
39 |
<ItemSize/> |
(Item Attribute) Size |
|
|
40 |
<ItemClass/> |
(Item Attribute) Class |
|
|
41 |
<ItemColor/> |
(Item Attribute) Color |
|
|
42 |
<ItemSeason/> |
(Item Attribute) Season |
|
|
43 |
<Length>0.00</Length> |
|
|
|
44 |
<Width>0.00</Width> |
|
|
|
45 |
<Height>0.00</Height> |
|
|
|
46 |
<Description>Extra Probiotics Intensive Formula 30ct (Blister)</Description> |
Item Description |
|
|
47 |
<UnitCurrency>HKD</UnitCurrency> |
Currency of product |
|
|
48 |
<UnitPrice>0.000</UnitPrice> |
Unit Price |
|
|
49 |
<UniqueItemBarcode/> |
UPC barcode |
|
|
50 |
<ProductionCountryCode/> |
Country of origin |
|
|
51 |
</Inventory> |
|
|
|
52 |
</Response> |
|
|