API docs by Redocly

NX One Piece 系統文件 (1.0.0)

Download OpenAPI specification:

NX One Piece 系統相關的系統說明

auth-api

授權相關 API

使用者登入

登入使用者帳號用的 API

Authorizations:
None
header Parameters
X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

Request Body schema: application/json
required
email
required
string

使用者信箱

password
required
string

登入的密碼

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

以員工編號作登入

以員工編號作登入的 API (登入完善前用的臨時機制)

Authorizations:
None
header Parameters
X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

Request Body schema: application/json
required
employeeNumber
required
string

員工編號

Responses

Request samples

Content type
application/json
{
  • "employeeNumber": "string"
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

更新 Token

將授權更新它的期限，並取得新的 Token

Authorizations:
None
header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

登出

釋放 Token 並登出

Authorizations:
None
header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

factory-api

工廠/實體店相關 API

取得工廠/實體店的清單

取得工廠/實體店的清單的 API

Authorizations:
None
header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": [
    ]
}

station-api

工作站相關 API

取得指定工作階段的工作站資訊

取得指定工作階段的工作站資訊 API

Authorizations:
None
path Parameters
stationCode
required
string

工作站的代碼

stage
required
string
Enum: "waiting_label" "batch_waiting_label" "picking" "print" "pack" "ship"

指定的工作階段：

  • waiting_label：等待面單/提單
  • batch_waiting_label：批次等待面單/提單
  • picking：撿料階段
  • print：印刷階段
  • pack：包裝階段
  • ship：出貨階段
header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

綁定撿料箱到工作站

綁定撿料箱到工作站 API

Authorizations:
None
path Parameters
stationCode
required
string

工作站的代碼

stage
required
string
Enum: "waiting_label" "batch_waiting_label" "picking" "print" "pack" "ship"

指定的工作階段：

  • waiting_label：等待面單/提單
  • batch_waiting_label：批次等待面單/提單
  • picking：撿料階段
  • print：印刷階段
  • pack：包裝階段
  • ship：出貨階段
header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Request Body schema: application/json
required
wareNumber
required
string

要綁定的撿料箱

mode
required
string
Enum: "raw_product" "final_product"

綁定撿料箱的模式：

  • raw_product：原料箱模式
  • final_product：成品箱模式

Responses

Request samples

Content type
application/json
{
  • "wareNumber": "string",
  • "mode": "raw_product"
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

ware-api

撿料箱相關 API

取得撿料箱的內容

取得撿料箱的內容 API

Authorizations:
None
path Parameters
wareNumber
required
string

撿料箱的編號

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

package-type-api

包裝類型相關的 API

取得指定用途的包裝類型清單

取得指定用途的包裝類型清單 API

Authorizations:
None
path Parameters
purpose
required
string

指定的用途。product 產品包裝，shipping 出貨包裝

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": [
    ]
}

ng-reason-api

NG 原因相關的 API

取得 NG 原因的內容

取得 NG 原因的內容 API

Authorizations:
None
path Parameters
stage
required
string
Enum: "waiting_label" "batch_waiting_label" "picking" "print" "pack" "ship"

指定的工作階段：

  • waiting_label：等待面單/提單
  • batch_waiting_label：批次等待面單/提單
  • picking：撿料階段
  • print：印刷階段
  • pack：包裝階段
  • ship：出貨階段
header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": [
    ]
}

picking-api

撿料相關 API

取得撿料車的內容

取得撿料車的內容 API

Authorizations:
None
path Parameters
carNumber
required
string

撿料車的編號

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
Example
{
  • "ok": true,
  • "data": {
    }
}

開始撿料

開始撿料的 API

Authorizations:
None
path Parameters
carNumber
required
string

撿料車的編號

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Request Body schema: application/json
required
Array (non-empty)
number
required
string

撿料箱的編號

pickingType
required
string
Enum: "customized" "normal" "order"

撿料的類別：

  • customized：客製單的撿料
  • normal：一般品的撿料
  • order：指定訂單的撿料
orderNumber
string

指定訂單的編號

grid
required
integer

撿料格的編號

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

取得並同步指定品項即時的撿料位置

取得並同步指定品項即時的撿料位置 API

Authorizations:
None
path Parameters
processingItemId
required
integer

加工品項的 ID

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

撿出指定的加工品項

撿出指定的加工品項 API

Authorizations:
None
path Parameters
carNumber
required
string

撿料車的編號

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Request Body schema: application/json
required
barcode
required
string

用來撿料的條碼

sequence
required
integer

放到撿料箱中的順序

processingItemId
integer

加工品項的 ID

wareNumber
required
string

撿料箱的編號

Responses

Request samples

Content type
application/json
{
  • "barcode": "string",
  • "sequence": 0,
  • "processingItemId": 0,
  • "wareNumber": "string"
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

完成撿料車的撿料

完成撿料車的撿料 API

Authorizations:
None
path Parameters
carNumber
required
string

撿料車的編號

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": [
    ]
}

取得撿料箱的應退回撿料並暫存的狀態

取得撿料箱的應退回撿料並暫存的狀態 API

Authorizations:
None
path Parameters
carNumber
required
string

撿料車的編號

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": [
    ]
}

以品項為單位來退回撿料

以品項為單位來退回撿料 API

Authorizations:
None
path Parameters
carNumber
required
string

撿料車的編號

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Request Body schema: application/json
required
processingItemIds
required
Array of integers

加工品項 IDs

Responses

Request samples

Content type
application/json
{
  • "processingItemIds": [
    ]
}

Response samples

Content type
application/json
{
  • "ok": true
}

以撿料箱為單位來退回撿料

以撿料箱為單位來退回撿料 API

Authorizations:
None
path Parameters
carNumber
required
string

撿料車的編號

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Request Body schema: application/json
required
wareNumbers
required
Array of strings

撿料箱的編號

Responses

Request samples

Content type
application/json
{
  • "wareNumbers": [
    ]
}

Response samples

Content type
application/json
{
  • "ok": true
}

回報找不到撿料品

回報找不到撿料品的 API

Authorizations:
None
path Parameters
processingItemId
required
integer

要撿料的加工品項的 ID

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

檢查撿料箱是否能使用指定的撿料類型

檢查撿料箱是否能使用指定的撿料類型的 API

Authorizations:
None
path Parameters
wareNumber
required
string

撿料箱的編號

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Request Body schema: application/json
required
pickingType
required
string
Enum: "customized" "normal" "order"

撿料的類別：

  • customized：客製單的撿料
  • normal：一般品的撿料
  • order：指定訂單的撿料
orderNumber
string

指定訂單的編號

Responses

Request samples

Content type
application/json
{
  • "pickingType": "customized",
  • "orderNumber": "string"
}

Response samples

Content type
application/json
{
  • "ok": true
}

print-api

印刷相關的 API

開始印刷

開始印刷 API

Authorizations:
None
path Parameters
processingItemId
required
integer

要撿料的加工品項的 ID

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Request Body schema: application/json
required
jigNumber
required
string

治具的編號

fixtureNumber
required
string

仿型的編號

Responses

Request samples

Content type
application/json
{
  • "jigNumber": "string",
  • "fixtureNumber": "string"
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

完成印刷

完成印刷 API

Authorizations:
None
path Parameters
processingItemId
required
integer

要撿料的加工品項的 ID

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

取得工作階段的最後檢查內容

取得工作階段的最後檢查內容 API

Authorizations:
None
path Parameters
stationCode
required
string

工作站的代碼

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

將加工品項綁定到工作站庫存箱

將加工品項綁定到工作站庫存箱 API

Authorizations:
None
path Parameters
stationCode
required
string

工作站的代碼

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Request Body schema: application/json
required
processingItemId
required
integer

要綁定的加工品項

trackingCode
required
string

要綁定的流水編號

Responses

Request samples

Content type
application/json
{
  • "processingItemId": 0,
  • "trackingCode": "string"
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

回報 NG

回報 NG API

Authorizations:
None
path Parameters
processingItemId
required
integer

要撿料的加工品項的 ID

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Request Body schema: application/json
required
ngReasonId
required
integer

回報的 NG 原因

Responses

Request samples

Content type
application/json
{
  • "ngReasonId": 0
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

pack-api

包裝相關的 API

取得加工品項的包裝資訊

取得加工品項的包裝資訊 API

Authorizations:
None
path Parameters
processingItemId
required
integer

要取得包裝資訊的加工品項 ID

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

完成品項的包裝

完成品項的包裝 API

Authorizations:
None
path Parameters
processingItemId
required
integer

要完成包裝的加工品項 ID

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Request Body schema: application/json
required
stationCode
required
string

工作站的代碼

startPackingTime
string^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01...

此品項在前端作業開始的時間，用來紀錄工時用。

Responses

Request samples

Content type
application/json
{
  • "stationCode": "S01",
  • "startPackingTime": "2025-01-01 00:00:00"
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

列印加工品項的標籤

列印加工品項的標籤 API

Authorizations:
None
path Parameters
processingItemId
required
integer

要列印標籤的加工品項 ID

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

取得工作站未出的出貨單資訊

取得工作站未出的出貨單資訊 API

Authorizations:
None
query Parameters
stationCode
string

指定的工作站代號。如果不帶則是不指定工作站。

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": [
    ]
}

取得指定的出貨單

取得指定的出貨單 API

Authorizations:
None
path Parameters
shippingOrderId
required
integer

出貨單的 ID

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": { }
}

Fulfill 指定的出貨單

Fulfill 指定的出貨單 API

Authorizations:
None
path Parameters
shippingOrderId
required
integer

出貨單的 ID

header Parameters
Authorization
required
string
Example: Bearer {Token}

已授權的 Token，用來和後端溝通授權的相關確認

X-Client-Timezone
string
Default: Asia/Taipei
Examples:
  • Asia/Taipei - 時區名稱格式
  • +08:00 - UTC 偏移格式

告訴後端目前客戶端的時區是什麼，後端回應的資料將自動轉換成客戶端的時區時間

X-Locale
string
Default: zh_TW
Example: en

告訴後端目前前端的語系是什麼。

X-Factory-Id
required
integer or string
Examples:
  • 123 - 工廠的 ID
  • F01 - 工廠的代碼

告訴後端目前所屬的工廠/實體店是哪一個。備註：選擇以 Factory ID 或是 Factory Code 皆可。

Request Body schema: application/json
required
stationCode
required
string

工作站的代碼

packageTypeCode
required
string

包裝的類型代碼

Responses

Request samples

Content type
application/json
{
  • "stationCode": "S01",
  • "packageTypeCode": "string"
}

Response samples

Content type
application/json
{
  • "ok": true,
  • "data": {
    }
}

ship-api

出貨相關的 API