建立物流訂單 / 開啟物流選擇頁

應用場景：

當廠商欲讓消費者頁面導向至物流選擇頁時，可呼叫此API以取得導向物流選擇頁相關之html內容。
使用者可於物流選擇頁填寫配送通路、收件人資訊等資料，並且建立暫存物流訂單。
綠界傳送暫存物流訂單資料並將頁面導至廠商指定的Client端回覆網址(ClientReplyURL)。
廠商收到綠界的回傳資料。

注意事項：

請避免使用另開視窗或iframe技術，詳細請參考。

API介接網址：

測試環境：https://logistics-stage.ecpay.com.tw/Express/v2/RedirectToLogisticsSelection
正式環境：https://logistics.ecpay.com.tw/Express/v2/RedirectToLogisticsSelection

HTTPS 傳輸協定

Content Type ：application/json
HTTP Method ：POST

特店傳入參數(Json格式)

PlatformID String(10)
特約合作平台商代號

PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant)，或平台商本身，此參數請帶放空值。
若隸屬於特約平台商的一般特店，此參數請帶放平台商的MerchantID。

MerchantID String(10)
特店編號 必填

RqHeader Object
傳入資料 必填

Timestamp String(10)
傳入時間 必填

請將傳輸時間轉換為時間戳(GMT+8)，綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。

注意事項：

驗證時間區間為 5 分鐘內有效，若超過此驗證時間則此次訂單將無法建立，產生時間戳請參考相關資料。
合作特店須進行主機「時間校正」，避免主機產生時差，延伸API無法正常運作。

Data String
加密資料 必填

回傳相關資料，此為加密過JSON格式的資料。加密方法說明

特店傳入參數範例(Json格式)

				
					{
    "MerchantID": "2000132",
    "RqHeader": {
        "Timestamp": "1525168923"
    },
    "Data": "加密資料"
}

Data參數說明(Json格式)

TempLogisticsID String(20) 綠界暫存物流訂單編號 必填

新建暫存物流訂單時，此參數請帶0。
若有帶入綠界提供之暫存訂單編號，則預設物流選擇頁將顯示該編號對應之訂單資料。
若帶入參數為無效，物流選擇頁將顯示錯誤資訊。

GoodsAmount Int 商品金額 必填

商品金額範圍為1~20000元

IsCollection String(1)
是否代收貨款

N：不代收貨款，為預設值。
Y：代收貨款，帶入Y則物流選擇頁將不會出現宅配選項

GoodsName String(50) 商品名稱 必填

注意事項：

不得輸入^ ‘ ` ! @ # % & * + \ ” < >| _ [ ]等特殊符號
優先檢核是否有特殊字元，再檢核是有超過長度限制
長度限制檢核規則 :
中文佔2字元、全形佔2字元、其餘佔1字元

SenderName String(10) 寄件人姓名 必填

注意事項：

字元限制為4~10個字元(例：半形英文可支援4~10個字，中文可支援2~5個字)
不可帶入不符合姓名規則的文字如表情圖示(emoji符號)

注意事項：不可帶入數字和特殊符號(禁用特殊符號如下所示)

SenderZipCode String(6) 寄件人郵遞區號 必填

SenderAddressString(60) 寄件人地址 必填

Remark String(60)
備註

ServerReplyURL String(200) Server端回覆網址 必填

物流狀態都會透過此URL通知。

ClientReplyURL String(200) Client端回覆網址 必填

暫存訂單的建立結果，會採用「Client POST」的方式將頁面導向「Client端回覆網址」(ClientReplyURL)並傳送結果資料。

Temperature String(4)
溫層

0001:常溫 (預設值)
0002:冷藏
0003:冷凍

注意事項：如需UNIMARTFREEZE(7-ELEVEN冷凍店取B2C)選項，請帶入0003冷凍

Specification String(4)
規格

0001: 60cm (預設值)
0002: 90cm
0003: 120cm
0004: 150cm

注意事項：溫層選擇0002:冷藏和0003:冷凍時，此規格參數不可帶入0004:150cm

ScheduledPickupTime String(1)
預定取件時段

宅配物流商預定取貨的時段
1: 9~12
2: 12~17
4: 不限時(固定填4不限時)

ReceiverAddress String(60)
收件人地址

若此參數有帶入值，將自動帶入物流選擇頁的對應欄位中。

ReceiverCellPhone String(10)
收件人手機

若此參數有帶入值，將自動帶入物流選擇頁的對應欄位中。

注意事項：只允許數字、長度限制10碼且必須以09開頭

ReceiverPhone String(20)
收件人電話

若此參數有帶入值，將自動帶入物流選擇頁的對應欄位中。

ReceiverName String(10)
收件人姓名

若此參數有帶入值，將自動帶入物流選擇頁的對應欄位中。

注意事項：

字元限制為4~10個字元(例：半形英文可支援4~10個字，中文可支援2~5個字)
不可帶入不符合姓名規則的文字如表情圖示(emoji符號)

注意事項：不可帶入數字和特殊符號(禁用特殊符號如下所示)

EnableSelectDeliveryTime String(1)
是否允許選擇送達時間

N：不允許(預設值)。
Y：允許

EshopMemberID String(24)
廠商平台的會員ID

允許英文、數字組成

注意事項：若此參數有帶入值，且使用者於物流選擇頁有勾選「您同意綠界科技股份有限公司記錄您上述收件資訊，以利您日後於該店消費時之收件資訊。」欄位，綠界將記錄使用者於物流選擇頁中輸入的配送通路及收件人資料，以利於下次使用物流選擇頁時，自動帶入前一次輸入的資料。

Data參數範例

				
					{
"TempLogisticsID": "0",
"GoodsAmount": 500,
"IsCollection": "Y",
"GoodsName": "商品名",
"SenderName": "王小明",
"SenderZipCode": "123",
"SenderAddress": "xxxxxxxx",
"Remark": "xxx",
"ServerReplyURL": "https://xxxx.com/xxx",
"ClientReplyURL": "https://xxxx.com/yyy ",
"Temperature": "0001",
"Specification": "0001",
"ScheduledPickupTime": "4",
"ReceiverAddress": "xxxxxxxx",
"ReceiverCellPhone": "09xxxxxxxx",
"ReceiverPhone": "xxxxxxxx",
"ReceiverName": "陳小明",
"EnableSelectDeliveryTime": "Y",
"EshopMemberID": "xxxxyyyy123"
}

綠界Response參數

ResultData String
回傳參數 必填

Json格式的字串

ResultData參數說明(Json格式)

PlatformID String(10)
特約合作平台商代號

PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant)，或平台商本身，此參數請帶放空值。
若隸屬於特約平台商的一般特店，此參數請帶放平台商的MerchantID。

MerchantID String(10)
特店編號

RpHeader Object
回傳資料

Timestamp String(10)
回傳時間

請將傳輸時間轉換為時間戳(GMT+8)，綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。

注意事項：

驗證時間區間為 5 分鐘內有效，若超過此驗證時間則此次訂單將無法建立，產生時間戳請參考相關資料。
合作特店須進行主機「時間校正」，避免主機產生時差，延伸API無法正常運作。

TransCode Int
回傳代碼

1 代表 API 傳輸資料(MerchantID, RqHeader, Data)接收成功，實際的 API 執行結果狀態請參考 RtnCode。

TransMsg String(200)
回傳訊息

回傳訊息

Data String
加密資料

回傳相關資料，此為加密過JSON格式的資料。加密方法說明

ResultData參數範例

				
					{
"MerchantID": "2000132",
    "RpHeader": {
        "Timestamp": "1525169058"
    },
    "TransCode": 1,
    "TransMsg": "",
    "Data": "加密資料"
}

Data參數說明(Json格式)

RtnCode Int
回應代碼

1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。

RtnMsg String(200)
回應訊息

TempLogisticsID String(20)
綠界暫存物流訂單編號

請保存暫存物流訂單編號，此編號作為建立正式物流訂單使用。

LogisticsType String(20)
物流類型

LogisticsSubType String(20)
物流子類型

物流方式一覽表

ReceiverName String(100)
收件人姓名

ReceiverPhone String(20)
收件人電話

ReceiverCellPhone String(20)
收件人手機

ReceiverAddress String(200)
收件地址

ReceiverZipCode String(6)
收件人郵遞區號

ScheduledDeliveryDate String(10)
預定送達日期

格式為yyyy/MM/dd

ScheduledDeliveryTime String(2)
預定送達時段

宅配物品預定送達的時段
1: 13前
2: 14~18
4:不限時

ReceiverStoreID String(6)
收件人門市代號

ReceiverStoreName String(10)
收件門市名稱

Data參數範例

				
					{
    "RtnCode": 1,
    "RtnMsg": "成功",
    "TempLogisticsID": "11256",
    "LogisticsType": "CVS",
    "LogisticsSubType": "UNIMARTC2C",
    "ReceiverName": "xxx",
    "ReceiverPhone": "02-xxxxxxxx",
    "ReceiverCellphone": "09xxxxxxxx",
    "ReceiverAddress": "xxxxxxxxxxx",
    "ReceiverZipCode": "12345",
    "ScheduledDeliveryDate": "",
    "ScheduledDeliveryTime": "",
    "ReceiverStoreID": "xxxxxx",
    "ReceiverStoreName": "xx門市"
}

綠界官方網站