## 商品 / **商品庫存查詢**(*oms.goods.inventory.query*)
###### 最后更新日期:**2024-04-10 12:00:00**
*****
### **API描述**
接入方調用該接口,進行商品查詢。
*****
### **公共參數說明**
| 參數名稱 | 類型 | 必填 | 描述 | 示例值 |
| --- | --- | --- | --- | --- |
| app\_key | String(32) | 是 | 接入方AppKey,由平臺對接人員提供 | |
| method | String(128) | 是 | 接口名稱 | oms.goods.inventory.query |
| version | String(10) | 是 | 接口版本 | 1.0 |
| biz\_content | Text | 是 | 業務參數的集合,并以**JSON格式**表示,并做urlencode處理,最大長度不限 | |
| sign | String(32) | 是 | 請求參數簽名值,參考【簽名加密】 | |
### **biz\_content參數說明**
| 參數名稱 | 類型 | 必填 | 描述 | 示例值 |
| --- | --- | --- | --- | --- |
| goods_type | String | 是 | 商品類型:DISTRIBUTION-分銷商品 | DISTRIBUTION |
| item\_id\_list | List \<String\> | 是 | 商品規格編碼數組 |["B48970026","B48970064","B73502930"] |
```
biz_content參數原文樣例:
{"goods_type":"DISTRIBUTION","item_id_list":["B48970026","B48970064","B73502930"]}
urlencode轉碼后:
%7B%22goods_type%22%3A%22DISTRIBUTION%22%2C%22item_id_list%22%3A%5B%22B48970026%22%2C%22B48970064%22%2C%22B73502930%22%5D%7D
```
*****
### **響應參數說明**
| 參數名稱 | 類型 | 必填 | 描述 | 示例值 |
| --- | --- | --- | --- | --- |
| code | Int| 是 | 響應代碼(0為成功,非0有異常) | 0 |
| msg | String | 是 | 響應描述 | success |
| data | Object | 是 | 響應數據 | |
### **data參數說明**
| 參數名稱 | 類型 | 必填 | 描述 | 示例值 |
| --- | --- | --- | --- | --- |
| item_list | Object | 是 | 商品數據體 | |
### **item_list參數說明**
| 參數名稱 | 類型 | 必填 | 描述 | 示例值 |
| --- | --- | --- | --- | --- |
| goods\_sku | String | 是 | 商品規格編碼 | B48970026 |
| sku\_name | String | 是 | 商品名稱 | 益生菌膠囊 |
| good_quantity | Int | 是 | 良品數量 | 10 |
| lock_quantity | Int | 是 | 鎖定數量 | 0 |
| available_quantity | Int | 是 | 可用數量(可用數量=良品數量-鎖定數量) | 10 |
```
{
"code": 0,
"msg": "success",
"data": {
"item_list": [
{
"goods_sku": "B48970026",
"sku_name": "WONDERLAB女性益生菌膠囊30粒",
"good_quantity": 0,
"lock_quantity": 0,
"available_quantity": 0
},
{
"goods_sku": "B48970064",
"sku_name": "WONDERLAB男士多維片60粒",
"good_quantity": 128,
"lock_quantity": 0,
"available_quantity": 128
},
{
"goods_sku": "B73502930",
"sku_name": "BioGaia拜奧Gastrus咀嚼片30粒",
"good_quantity": 890,
"lock_quantity": 0,
"available_quantity": 890
},
{
"goods_sku": "B48970026",
"sku_name": "WONDERLAB女性益生菌膠囊30粒",
"good_quantity": 0,
"lock_quantity": 0,
"available_quantity": 0
},
{
"goods_sku": "B48970064",
"sku_name": "WONDERLAB男士多維片60粒",
"good_quantity": 128,
"lock_quantity": 0,
"available_quantity": 128
}
]
}
}
```