Get Warehouse
Notice
Only available to POS enabled merchants.
僅提供使用 POS 的店家使用。
Function
To get merchant's warehouses information
獲取店家倉庫資料
URL
GET <<api_domain>>/v1/warehouses
Request parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| page | Integer | Page Number 頁數 (Default: 1) | page=1 |
| per_page | Integer | Numbers of Products per page 每頁顯示 n 筆資料 (Default: 24) | per_page=24 |
| excludes | String | Could exclude certain parameters in the response 結果要排除哪些參數 | excludes[]=items.status |
| fields | String | Could only show certain parameters in the response 結果只顯示哪些參數 | fields[]=items.status |
Response fields
| Field | Type | Description | Example |
|---|---|---|---|
| items | Warehouse | Array of Products 倉庫資訊 | Please check the link on the left |
| pagination | Pagination | Pagination Data 頁面資訊 | Please check the link on the left |
Response example
{
"items": [
{
"id": "5e83216e2e4f81001e756014",
"name": "台北總店",
"status": "active"
},
{
"id": "5e831cb68fa5fc000f9925ab",
"name": "預設倉庫",
"status": "active"
}
],
"pagination": {
"current_page": 1,
"per_page": 24,
"total_pages": 1,
"total_count": 2
}
}
Updated almost 3 years ago