mama/star-erp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[DOCS] 更新 API 文件，補充 api-test-01 測試倉說明
All checks were successful
ERP-Deploy-Demo / deploy-demo (push) Successful in 55s
Details

Browse Source
This commit is contained in:
sky121113
2026-03-10 11:57:34 +08:00
parent d52a215916
commit adf13410ba
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
resources/markdown/manual/api-integration.md
View File

@@ -85,7 +85,7 @@ Star ERP 系統提供外部整合 API (Integration API) 供電商前台、POS
| 參數名稱 | 類型 | 必填 | 說明 | | 參數名稱 | 類型 | 必填 | 說明 |
| :--- | :--- | :---: | :--- | | :--- | :--- | :---: | :--- |
| `warehouse_code` | String | **是** | 要查詢的倉庫代碼 (例如：`STORE-001`) | | `warehouse_code` | String | **是** | 要查詢的倉庫代碼 (例如：`STORE-001`，測試可使用預設建立之 `api-test-01`) |
### Response ### Response
@@ -94,7 +94,7 @@ Star ERP 系統提供外部整合 API (Integration API) 供電商前台、POS
```json ```json
{ {
"status": "success", "status": "success",
"warehouse_code": "STORE-001", "warehouse_code": "api-test-01",
"data": [ "data": [
{ {
"external_pos_id": "POS-ITEM-001", "external_pos_id": "POS-ITEM-001",
@@ -136,7 +136,7 @@ Star ERP 系統提供外部整合 API (Integration API) 供電商前台、POS
| 欄位名稱 | 型態 | 必填 | 說明 | | 欄位名稱 | 型態 | 必填 | 說明 |
| :--- | :--- | :---: | :--- | | :--- | :--- | :---: | :--- |
| `external_order_id` | String | **是** | 第三方系統中的唯一訂單編號，不可重複 (Unique) | | `external_order_id` | String | **是** | 第三方系統中的唯一訂單編號，不可重複 (Unique) |
| `warehouse_code` | String | **是** | 指定扣除庫存的倉庫代碼 (例如：`STORE-001`)。若找不到對應倉庫將直接拒絕請求 | | `warehouse_code` | String | **是** | 指定扣除庫存的倉庫代碼 (例如：`api-test-01` 測試倉)。若找不到對應倉庫將直接拒絕請求 |
| `payment_method` | String | 否 | 付款方式，僅接受：`cash`, `credit_card`, `line_pay`, `ecpay`, `transfer`, `other`。預設為 `cash` | | `payment_method` | String | 否 | 付款方式，僅接受：`cash`, `credit_card`, `line_pay`, `ecpay`, `transfer`, `other`。預設為 `cash` |
| `sold_at` | String(Date) | 否 | 交易發生時間，預設為當下時間 (格式: YYYY-MM-DD HH:mm:ss) | | `sold_at` | String(Date) | 否 | 交易發生時間，預設為當下時間 (格式: YYYY-MM-DD HH:mm:ss) |
| `items` | Array | **是** | 訂單明細陣列，至少需包含一筆商品 | | `items` | Array | **是** | 訂單明細陣列，至少需包含一筆商品 |
@@ -153,7 +153,7 @@ Star ERP 系統提供外部整合 API (Integration API) 供電商前台、POS
```json ```json
{ {
"external_order_id": "ORD-20231026-0001", "external_order_id": "ORD-20231026-0001",
"warehouse_code": "STORE-001", "warehouse_code": "api-test-01",
"payment_method": "credit_card", "payment_method": "credit_card",
"sold_at": "2023-10-26 14:30:00", "sold_at": "2023-10-26 14:30:00",
"items": [ "items": [