查詢單一客戶
查詢單一客戶
依 id 查詢單一客戶。若該 id 不存在,或屬於其他租戶,一律回傳 404 not_found,兩種情況無法從回應內容區分。
Authentication
X-Signaturestring
每個 /v1 請求都必須帶 X-Client-Id、X-Timestamp、X-Nonce 與 X-Signature 四個標頭。X-Signature 是以 client secret 對 canonical string 做 HMAC-SHA256 後的 Base64。canonical string 的組成、可複製的簽章範例與 401 排查步驟,請參閱「驗證與簽章」。
Path parameters
id
要查詢的客戶序號。不存在或屬於其他租戶時,一律回傳 404 not_found。
Response
OK
id
客戶序號。
outerSysCode
ERP 端的客戶代碼。
name
企業名稱。
shortName
企業簡稱。
cellPhone
公司電話。
shippingAddress
收貨地址。
internalUserId
負責業務(內部使用者)的序號。
status
客戶狀態,Active(啟用)或 Inactive(停用)。透過本 API 建立的客戶一律為 Active;後續狀態變更由後台維護,本 API 目前不提供寫入。
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error