---
# System prepended metadata

title: GI Portal 系統整合服務規範

---

# GI Portal 系統整合服務規範

## A. API 格式說明
::: info
每個 API 以單一介面方式提供，平台並採用 RESTful API 形式傳遞參數給服務，輸出的文件內容結構以 JSON 為主。
:::

## B. API 設計規格說明

> | 介面         | 用途說明             |
> |:------------ |:-------------------- |
> | 商品基本資訊   | 提供商品基本資訊     |
> | 商品下單資訊 | 提供商品下單資訊     |
> | 商品庫存     | 提供商品可用庫存數量 | 
> | 客戶訂單資訊 | 提供客戶訂單資料     |

> ### 1. 商品基本資訊
> * Https Request
> >a. 請求方式 : POST
> >b. 網址結構 : https://<font color='EE0000'>domain</font>/<font color='009900'>api</font>/<font color='0000AA'>giportal</font>/<font color='EE00AA'>gmcsku</font>/<font color='EEE0AA'>client</font>
> >
> >| URL字段  | 描述                          |
> >| -------- | ----------------------------- |
> >| domain   | 網域名稱                      |
> >| api      | 固定值，表示API服務           |
> >| giportal | 固定值，表示GI Portal系統服務 |
> >| gmcsku   | 固定值，表示請求工廠物料基本資料  |
> >| client   | SAP客戶端，測試為700/正式為800   | 
> >
> > c. 參數結構說明
> > 
> >| 欄位 | 描述                          |
> >| ---- | ----------------------------- |
> >| gmc_skus | 工廠物料號碼，陣列類型(Array) |
> >
> >``` 
> >['10021G9ABC22','10021G9ABC23']
> >```
> * Https Response
> > a. 參數結構說明 
> > b. 內容為 JSON 格式
> >
> >| 欄位        | 描述                       |
> >| ----------- | -------------------------- |
> >| sku         | 客戶物料號碼，如沒資料則為空白 |
> >| gmc_sku     |工廠物料號碼
> >| description | 物料規格，如沒資料則為空白 |
> >| color       | 車種顏色，如沒資料則為空白 |
> >| brand       | 客戶品牌，如沒資料則為空白 |
> >| model_name   | 車種名稱，如沒資料則為空白 |
> >| model_size   | 車種尺寸，如沒資料則為空白 |
> >| model_year   | 車種年度，如沒資料則為空白 |
> >| vender_id    | 製造工廠，如沒資料則位空白 |
> >
> >``` 
> >[
> >    {
> >        "sku": "2100019203",
> >        "gmc_sku":"10021G9ABC22",
> >        "model_name": "TCR ADV 2 KOM",
> >        "description": "TCR ADV 2 KOM 700CX42.5M(XS) G-PT30M",
> >        "color": "UNICORN WHITE",
> >        "model_year": "MY21",
> >        "model_size": "XS",
> >        "vender_id": "GTM",
> >        "brand": "G01"
> >    },
> >    {
> >        "sku": "2100019208",
> >        "gmc_sku":"10021G9ABC23",
> >        "model_name": "TCR ADV 2 KOM",
> >        "description": "TCR ADV 2 KOM 700CX56M(XL) G-PT30M",
> >        "color": "UNICORN WHITE",
> >        "model_year": "MY21",
> >        "model_size": "XL",
> >        "vender_id": "GTM",
> >        "brand": "G01"
> >    }
> >]    
> >```

> ### 2. 商品下單資訊
> * Https Request
> >a. 請求方式 : POST
> >b. 網址結構 : https://<font color='EE0000'>domain</font>/<font color='009900'>api</font>/<font color='0000AA'>giportal</font>/<font color='EE00AA'>skuorderdata</font>/<font color='EEE0AA'>client</font>
> >
> >| URL字段      | 描述                          |
> >| ------------ | ----------------------------- |
> >| domain       | 網域名稱                      |
> >| api          | 固定值，表示API服務           |
> >| giportal     | 固定值，表示GI Portal系統服務 |
> >| skuorderdata | 固定值，表示請求商品訂單資料      |
> >| client       | SAP客戶端，測試為700/正式為800  |
> >
> > c. 參數結構說明
> > 
> >| 欄位 | 描述                          |
> >| ---- | ----------------------------- |
> >| gmc_skus | 工廠物料號碼，陣列類型(Array) |
> >
> >``` 
> >['10021G9ABC22','10021G9ABC22']
> >```
> * Https Response
> > a. 參數結構說明 
> > b. 內容為 JSON 格式
> >
> >| 欄位       | 描述                               |
> >| ---------- | ---------------------------------- |
> >| sku        | 客戶物料號碼，如沒資料則為空白  |
> >| gmc_sku    | 工廠物料號碼|
> >| fob        | 商品單價，如沒資料則為{}         |
> >| moq        | 商品最低下訂數量，如沒資料則為1 |
> >| limitation | 商品單位量，如沒資料則為1       |
> >``` 
> >    {
> >        "sku": "2100019203",
> >        "gmc_sku":"10021G9ABC22",
> >        "fob": {
> >            "GI": 1,
> >            "GIAR1": 873.2,
> >            "GIBO1": 900.8,
> >            "GIBR2": 900.8,
> >            "GICO1": 855.8,
> >            "GICR1": 873.2,
> >            "GIEG1": 900.8,
> >            "GIGT1": 855.8,
> >            "GIGU1": 900.8,
> >            "GIMY1": 855.8,
> >            "GINC1": 900.8,
> >            "GINP1": 900.8,
> >            "GIPA1": 873.2,
> >            "GIPF1": 873.2,
> >            "GIPH1": 855.8,
> >            "GIPK1": 873.2,
> >            "GIPR1": 855.8,
> >            "GIPY1": 900.8,
> >            "GISG1": 855.8,
> >            "GIAE3": 900.8,
> >            "GILK1": 900.8,
> >            "GIIL2": 900.8
> >        },
> >        "moq": "1.000",
> >        "limitation": "1.000"
> >    },
> >    {
> >        "sku": "2100019208",
> >        "gmc_sku":"10021G9ABC22",
> >        "fob": {
> >            "GI": 1,
> >            "GIAR1": 873.2,
> >            "GIBO1": 900.8,
> >            "GIBR2": 900.8,
> >            "GICO1": 855.8,
> >            "GIID2": 873.2,
> >            "GIIN5": 855.8,
> >            "GIKE2": 900.8,
> >            "GIKG1": 873.2,
> >            "GIKH1": 855.8,
> >            "GIKZ1": 873.2,
> >            "GIMU1": 900.8,
> >            "GIMY1": 855.8,
> >            "GINC1": 900.8,
> >            "GINP1": 900.8,
> >            "GIPA1": 873.2,
> >            "GIPH1": 855.8,
> >            "GIPK1": 873.2,
> >            "GIPR1": 855.8,
> >            "GISG1": 855.8,
> >            "GISV1": 873.2,
> >            "GITH1": 873.2,
> >            "GIVN3": 855.8,
> >            "GIZA1": 855.8,
> >            "GITH2": 855.8,
> >            "GITR3": 855.8,
> >            "GIEC2": 900.8
> >        },
> >        "moq": "1.000",
> >        "limitation": "1.000"
> >    }
> >```

> ### 3. 商品庫存
> * Https Request
> >a. 請求方式 : POST
> >b. 網址結構 : https://<font color='EE0000'>domain</font>/<font color='009900'>api</font>/<font color='0000AA'>giportal</font>/<font color='EE00AA'>stockquantity</font>/<font color='EEE0AA'>client</font>
> >
> >| URL字段       | 描述                          |
> >| ------------- | ----------------------------- |
> >| domain        | 網域名稱                      |
> >| api           | 固定值，表示API服務           |
> >| giportal      | 固定值，表示GI Portal系統服務 |
> >| stockquantity | 固定值，表示請求商品庫存數量     |
> >| client        | SAP客戶端，測試為700/正式為800  |
> >
> > c. 參數結構說明
> > 
> >| 欄位 | 描述                          |
> >| ---- | ----------------------------- |
> >| gmc_skus | 工廠物料號碼，陣列類型(Array) |
> >
> >``` 
> >['10021G9ABC22','10021G9ABC22']
> >```
> * Https Response
> > a. 參數結構說明 
> > b. 內容為 JSON 格式
> >
> >| 欄位          | 描述                            |
> >| ------------- | ------------------------------- |
> >| sku           | 客戶物料號碼，如沒資料則為空白 |
> >| gmc_sku       | 工廠物料號碼              |
> >| stock_quantity| 商品庫存數量                    |
> >``` 
> >[
> >    {
> >        "sku": "2100019208",
> >        "gmc_sku": "10021G9ABC22"
> >        "stock_quantity": "0.000"
> >    }
> >]
> >```

> ### 4. 客戶訂單資訊
> * Https Request
> >a. 請求方式 : POST
> >b. 網址結構 : https://<font color='EE0000'>domain</font>/<font color='009900'>api</font>/<font color='0000AA'>giportal</font>/<font color='EE9FAA'>saleorder</font>/<font color='EE00AA'>find</font>/<font color='EEE0AA'>client</font>
> >
> >| URL字段   | 描述                           |
> >| --------- | ------------------------------ |
> >| domain    | 網域名稱                       |
> >| api       | 固定值，表示API服務            |
> >| giportal  | 固定值，表示GI Portal系統服務  |
> >| saleorder | 固定值，表示請求訂單資料       |
> >| find      | 固定值，表示請求搜尋行為       |
> >| client    | SAP客戶端，測試為700/正式為800 |
> >
> > c. 參數結構說明
> > 
> >| 欄位    | 描述         |
> >| ------- | ------------ |
> >| order_id | 訂單號碼     |
> >| gmc_sku     | 工廠物料號碼 | 
> >
> >``` 
> >[
> >    {
> >        "order_id" : "0050000622", 
> >        "gmc_sku":"10021G9ABC22"
> >        
> >    },
> >    {
> >        "order_id" : "0100090000", 
> >        "gmc_sku":"10021G9ABC22"
> >    }
> >]
> >```
> * Https Response
> > a. 參數結構說明 
> > b. 內容為 JSON 格式
> >
> >| 欄位             | 描述         |
> >| ---------------- | ------------ |
> >| order_id          | 訂單號碼     | 
> >| sku              | 客戶物料號碼，如沒資料則為空白 |
> >| gmc_sku|工廠物料號碼|
> >| unmade_quantity   | 未出貨數量   |
> >| stock_quantity    | 已備貨數量   |
> >| shipping_quantity | 已出貨數量   |
> >``` 
> >[
> >    {
> >       "order_id": "0100090001",
> >       "sku": "2100019208",
> >       "gmc_sku":"10021G9ABC22",
> >       "unmade_quantity": "1.000",
> >       "stock_quantity": "0.000",
> >       "shipping_quantity": "0"
> >    },
> >    {
> >       "order_id": "0100090000",
> >       "sku": "2100019208",
> >       "gmc_sku":"10021G9ABC22",
> >       "unmade_quantity": "1.000",
> >       "stock_quantity": "0.000",
> >       "shipping_quantity": "0"
> >    }
> >]
> >```