應用場景
使用者在特店(賣家會員)消費後，特店(賣家會員)將結帳完成的出貨資訊POST至綠界科技進行物流出貨作業。
API介接網址
- 測試環境：https://logistics-stage.ecpay.com.tw/Express/Create
- 正式環境：https://logistics.ecpay.com.tw/Express/Create
HTTPS傳輸協定
- Accept：text/html
- Content Type：application/x-www-form-urlencoded
- HTTP Method：POST
特店Request參數說明
MerchantID String(10)
廠商編號 必填
由綠界科技提供
MerchantTradeNo String(20)
廠商交易編號
- 支援中文、數字、英文大小寫
- 廠商交易編號均為唯一值，不可重複使用
- 廠商交易編號可為空，系統會自動產生一組廠商訂單編號。
MerchantTradeDate String(20)
廠商交易時間 必填
請依消費者交易的當下時間設定
(此時間不會等於綠界建立物流訂單完成的時間)
格式為：yyyy/MM/dd HH:mm:ss
LogisticsType String(20)
物流類型 必填
- HOME:宅配
LogisticsSubType String(20)
物流子類型 必填
- TCAT:黑貓
- POST:中華郵政
GoodsAmount Int
商品金額 必填
商品金額範圍僅限為1元以上。
注意事項：因各宅配物流商都有不同的賠償上限金額，請勿帶入的商品金額超過最高可賠償金額。請參照各宅配商手冊說明
GoodsName String(50)
商品名稱
- 不得輸入^ ‘ ` ! @ # % & * + \ ” < >| _ [ ]等特殊符號。
- 若物流子類型[LogisticsSubType]為TCAT(黑貓)，請勿使用全形符號。
GoodsWeight Number
商品重量
- 當物流子類型[LogisticsSubType]為POST(中華郵政)，則此欄位不可為空。
- 上限20公斤，小數3位
- 單位是公斤
SenderName String(10)
寄件人姓名 必填
注意事項：
- 字元限制為4~10個字元(例：半形英文可支援4~10個字，中文可支援2~5個字)
- 不可帶入不符合姓名規則的文字如表情圖示(emoji符號)
注意事項：不可帶入數字和特殊符號(禁用特殊符號如下所示)
SenderPhone String(20)
寄件人電話
與寄件人手機(SenderCellPhone)擇一不可為空
注意事項：允許數字+特殊符號；特殊符號僅限()-#
SenderCellPhone String(20)
寄件人手機
與寄件人電話(SenderPhone)擇一不可為空
注意事項：只允許數字、長度為10碼、需為09開頭
SenderZipCode String(6)
寄件人郵遞區號 必填
SenderAddress String(60)
寄件人地址 必填
注意事項：
- 字元限制需大於6個字元，且不可超過60個字元。
- 若物流子類型[LogisticsSubType]為TCAT(黑貓)，請務必填寫正確完整地址，以避免建單失敗。
ReceiverName String(10)
收件人姓名 必填
注意事項：
- 字元限制為4~10個字元(例：半形英文可支援4~10個字，中文可支援2~5個字)
- 不可帶入不符合姓名規則的文字如表情圖示(emoji符號)
注意事項：不可帶入數字和特殊符號(禁用特殊符號如下所示)
ReceiverPhone String(20)
收件人電話
與收件人手機(ReceiverCellPhone)擇一不可為空
注意事項：允許數字+特殊符號；特殊符號僅限()-#
ReceiverCellPhone String(20)
收件人手機
與收件人電話(ReceiverPhone)擇一不可為空
注意事項：只允許數字、長度為10碼、需為09開頭
ReceiverZipCode String(6)
收件人郵遞區號 必填
ReceiverAddress String(60)
收件人地址 必填
注意事項：字元限制需大於6個字元，且不可超過60個字元
ReceiverEmail String(50)
收件人email
Temperature String(4)
溫層
- 0001:常溫 (預設值)
- 0002:冷藏
- 0003:冷凍
注意事項：當物流子類型[LogisticsSubType]為POST(中華郵政)，則該參數只能用0001:常溫
Distance String(2)
距離
- 00:同縣市 (預設值)
- 01:外縣市
- 02:離島
注意事項：
- 當系統檢查到收件人地址(ReceiverAddress)與寄件人地址(SenderAddress)所屬縣市與距離(Distance)輸入的值不相符時，系統將自動更正距離(Distance)為正確值。
- 中華郵政請忽略此參數
Specification String(4)
規格
- 0001: 60cm (預設值)
- 0002: 90cm
- 0003: 120cm
- 0004: 150cm
注意事項：
- 當溫層(Temperature)選擇【0002:冷藏】和【0003:冷凍】時，規格(Specification)請勿使用【0004:150cm】
- 當物流子類型[LogisticsSubType]為POST(中華郵政)時，請忽略此參數
ScheduledPickupTime String(1)
預定取件時段
- 宅配物流商預定取貨的時段
- 目前不提供預定取貨時段，請固定帶入4 (不限時)
注意事項：當物流子類型[LogisticsSubType]為POST(中華郵政)時，請忽略此參數
ScheduledDeliveryTime String(2)
預定送達時段
宅配物品預定送達的時段
- 1: 13點前
- 2: 14點~18點
- 3: 14點~18點
- 4:不限時
注意事項：當物流子類型[LogisticsSubType]為POST(中華郵政)時，請忽略此參數
TradeDesc String(200)
交易描述
注意事項：長度若超過200會自動截斷超過的部分
ServerReplyURL String(200)
Server端回覆網址 必填
物流狀態都會透過此URL通知
ClientReplyURL String(200)
Client端回覆網址
訂單建立成功後，才會將頁面導轉至此URL，反之則無作用。
注意事項：若要使用幕後建立訂單，此欄位請勿填寫。
Remark String(200)
備註
PlatformID String(10)
特約合作平台商代號
- 由綠界科技提供，此參數為專案合作的平台商使用，一般廠商介接請放空值。
- 若為專案合作的平台商使用時，請帶賣家所綁定的MerchantID。
CheckMacValue String
檢查碼 必填
請參考附錄檢查碼機制
綠界Response參數說明
MerchantID String(10)
廠商編號
MerchantTradeNo String(20)
廠商交易編號
訂單產生時傳送給綠界科技的廠商交易編號。
RtnCode Int
目前物流狀態
請參考物流狀態代碼一覽表。
RtnMsg String(200)
物流狀態說明
請參考物流狀態代碼一覽表。
AllPayLogisticsID String(20)
綠界科技的物流交易編號
請保存綠界科技的交易編號與 AllPayLogisticsID的關連。
LogisticsType String(20)
物流類型
LogisticsSubType String(20)
物流子類型
GoodsAmount Int
商品金額
商品遺失賠償依據
UpdateStatusDate String(20)
物流狀態更新時間
格式為：yyyy/MM/dd HH:mm:ss
ReceiverName String (60)
收件人姓名
ReceiverPhone String(20)
收件人電話
ReceiverCellPhone String(20)
收件人手機
ReceiverEmail String(50)
收件人email
ReceiverAddress String(200)
收件人地址
CVSPaymentNo String(15)
寄貨編號
CVSValidationNo String(10)
驗證碼
BookingNote String(50)
托運單號
物流類型[LogisticsType]為HOME才會回傳
CheckMacValue String
檢查碼
合作特店必須檢查CheckMacValue來驗證，請參考附錄檢查碼機制。
注意事項：
- 訂單產生成功後，請確認ServerReplyURL是否收到成功的物流狀態，確保後續能持續收到物流狀態通知。
幕後產生物流訂單回應訊息範例：
- 正確：
1|MerchantID=XXX&MerchantTradeNo=XXX&RtnCode=XXX&BookingNote=&RtnMsg=XXX&AllPayLogisticsID=XXX&LogisticsType=XXX&LogisticsSubType=XXX&GoodsAmount=XXX&UpdateStatusDate=XXX&ReceiverName=XXX&ReceiverPhone=XXX&ReceiverCellPhone=XXX&ReceiverEmail=XXX&ReceiverAddress=XXX&CVSPaymentNo=XXX &CVSValidationNo=XXX &CheckMacValue=XXX
- 錯誤：
0| ErrorMessage