建立客戶

View as Markdown

建立單一客戶。未帶 id 且 outerSysCode 未對應到既有客戶時新增;outerSysCode 已存在時改為更新該筆(冪等去重),重送同一份資料不會產生重複客戶。internalUserId(負責業務)可省略,省略時套用貴公司設定的預設業務。

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 排查步驟,請參閱「驗證與簽章」。

Request

This endpoint expects an object.
idlong or nullOptional

客戶序號。帶 id 時一律視為更新該筆客戶,不會再比對 outerSysCode;省略時改依 outerSysCode 判斷新增或更新。PUT /v1/customers/{id} 會忽略這裡的值,一律以路徑上的 id 為準。

outerSysCodestring or nullOptional

ERP 端的客戶代碼,用來與既有客戶比對、去重。新增時省略視為空字串;更新時省略保留現有值。長度上限 50 字元,超過回傳 400 outer_sys_code_too_long。

namestring or nullOptional

企業名稱。新增時省略視為空字串;更新時省略保留現有值。長度上限 50 字元,超過回傳 400 name_too_long。

shortNamestring or nullOptional

企業簡稱。新增時省略視為空字串;更新時省略保留現有值。長度上限 20 字元,超過回傳 400 short_name_too_long。

cellPhonestring or nullOptional

公司電話。新增時省略視為空字串;更新時省略保留現有值。長度上限 20 字元,超過回傳 400 cell_phone_too_long。

shippingAddressstring or nullOptional

收貨地址。新增時省略視為空字串;更新時省略保留現有值。長度上限 50 字元,超過回傳 400 shipping_address_too_long。

internalUserIdlong or nullOptional

負責業務(內部使用者)的序號,選填。新增時省略會套用貴租戶設定的預設業務;若租戶未設定預設業務,新增會失敗。更新時省略保留現有值。

Response

OK
idlongOptional

新增或更新成功後,該筆資料的 id。

Errors

401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error