FamilyFreezingC2C V2.2
全家店到店(冷凍)物流流程說明
取得店鋪資料並成立訂單取號
導向到選擇物流服務,取得店鋪相關資訊
(會將店號、店名、店址、物流服務、訂單編號、保留編號、出貨日期回傳至回傳店號網址)
完善訂單資料後組成JSON字串Post到建立物流單
建立訂單成功後至列印全家店到店冷凍物流網址獲取物流單標籤
請依電子地圖回傳的出貨日期進行出貨
(寄貨外箱須於全家購買,可在寄件前下載My FamiPort APP至附近全家預購寄件專用紙箱)
FamiFreezingC2C流程圖
FamiFreezingC2C API
網址連結
1. 選擇物流服務
說明
- 使用者在此頁面選擇取貨門市,選擇完畢後回傳門市資訊至帶入的回傳網址
- 當同一筆訂單編號進行重新選店,將清除原有的店鋪資料與取消保留編號
傳遞方式:Http POST method
API URL:/Member/Order/Choselogistics
Request
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
user_account | 商家主帳號 | string | 10 | Y | |
orderno | 訂單編號 | string | 27 | N | |
apicode | 商家api密碼 | string | 30 | Y | 請以TripleDESEncoding加密後傳送附錄 |
Logistic_serviceID | 物流服務ID | string | 2 | Y | 23:全家店到店物流(冷凍) |
returnUrl | 回傳網址 | string | 200 | Y | 回傳店號網址 |
Ecplateform | EC平台 | string | 20 | N |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
orderno | 商家訂單編號 | string | 20 | Y | 如有帶入訂單編號則回傳訂單編號 |
service | 物流服務 | string | 2 | Y | 23:全家店到店物流(冷凍) |
storeaddress | 店址 | string | 150 | Y | |
storename | 店名 | string | 30 | Y | |
storeid | 店ID | string | 10 | Y | |
ReservedNo | 保留編號 | string | 20 | Y | 超商預定冷凍存放空間編號 |
ShipDate | 出貨日期 | string | 10 | Y | 格式:yyyy-MM-dd 請於此日期前建立訂單並出貨 |
2. 建立物流訂單
說明
- 建立物流訂單
傳遞方式:Http POST method application/x-www-form-urlencoded
API URL:/api/Orderapi/Add_Order
Request
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
JsonOrder | 物流單資料 | string | Y | 資料組成JSON字串以TripleDESEncoding加密後UrlEncode傳送 附錄 |
JsonOrder Content
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
user_account | 商家主帳號 | string | 10 | Y | |
apicode | 商家api密碼 | string | 30 | Y | |
Logistic_service | 使用的物流服務 | string | 2 | Y | 固定為23 全家冷凍店到店 |
OrderNo | 商家訂單編號 | string | 27 | Y | 限英文與數字 |
DeliverMode | 取貨是否付款 | string | 2 | Y | 01:取貨付款 02:取貨不付款 |
TotalAmount | 總金額 | string | 5 | Y | 正整數且金額不可大於20000 |
Remark | 備註 | string | 200 | Y | 若不填入值請填空字串 |
Description | 單號描述 | string | 50 | Y | 若不填入值請填空字串 |
EC | EC平台 | string | 50 | N | |
receiver_storeid | 取件店號 | string | 30 | Y | |
receiver_storename | 取件店名 | string | 100 | Y | |
return_storeid | 退件店號 | string | 6 | Y | 若不填入值請填空字串 |
Receiver_Name | 收件人姓名 | string | 10 | Y | 中文最多10個字、英文20個字 |
Receiver_Phone | 收件人手機 | string | 10 | Y | |
Receiver_Email | 收件人EMAIL | string | 100 | Y | |
Receiver_address | 收件人地址 | string | 150 | Y | 請輸入取件店址 |
Sender_Name | 寄件人姓名 | string | 10 | Y | 中文最多10個字、英文20個字 |
Sender_Phone | 寄件人手機 | string | 10 | Y | |
Sender_Email | 寄件人EMAIL | string | 100 | Y | |
Sender_address | 寄件人地址 | string | 150 | Y | 如不填入 請填空字串 |
PassCode | 傳遞碼 | string | Y | 以下參數值依序組合起來成一段字串(不包含+號) : user_account + OrderNo + TotalAmount + apicode並使用sha-1雜湊函數取得組合字串的雜湊值附錄 | |
ReservedNo | 保留編號 | string | 20 | Y | 電子地圖回傳保留編號 |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
Status | 狀態 | string | 1 | Y | S:成功 F:失敗 |
LogisticNumber | PayNow物流單號 | string | 20 | Y | |
LogisticService | 物流服務名稱 | string | Y | 全家店到店冷凍 | |
LogisticServiceID | 物流服務代碼 | string | 2 | Y | 23:全家店到店物流(冷凍) |
ErrorMsg | 錯誤訊息 | string | Y | 成功則為null | |
paymentno | 物流商貨運編號 | string | Y | 超商物流配送編號 | |
ReturnMsg | 回傳訊息 | string | Y | ||
orderno | 商家訂單編號 | string | 27 | Y |
Objec Example
Request Object
{
"user_account":"28229955",
"apicode":"12345678",
"Logistic_service":"23",
"OrderNo":"211215145423",
"DeliverMode":"02",
"TotalAmount":"200",
"Remark":"",
"Description":"test",
"receiver_storeid":"005757",
"receiver_storename":"全家三重田心店",
"return_storeid":"",
"Receiver_Name":"收件測",
"Receiver_Phone":"0912345678",
"Receiver_Email":"123@paynow.com.tw",
"Receiver_address":"新北市三重區忠孝路三段50巷82號一樓",
"Sender_Name":"寄件測",
"Sender_Phone":"0900000000",
"Sender_Email":"test@paynow.com.tw",
"Sender_address":"",
"PassCode":"E73247AE62604CD2EF7EFC08480C4E7F41852C8C",
"ReservedNo":"21120300000000518064"
}
Response Object
{
"Status":"S",
"LogisticNumber":"MIJA002FR22112156425",
"LogisticService":"全家店到店冷凍",
"LogisticServiceID":"23",
"ReturnMsg":"",
"orderno":"211215145423",
"paymentno":"11000094930",
"ErrorMsg":null
}
3. 物流貨態回傳
說明
- 商家接收物流貨態,更新貨態時由PayNow傳送訂單貨態資料給商家
傳遞方式:Http Post method
Request
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
orderno | 商家自訂編號 | string | 30 | Y | |
OriginOrderno | 商家原始自訂單號 | string | 27 | Y | |
PayNowLogisticCode | 物流代碼 | string | 4 | Y | |
Detail_Status_Description | 物流狀態描述 | string | 2 | Y | |
paymentno | 物流商託運單號 | string | Y | ||
StoreDate | 到店日期 | string | N | 若代碼為5000/5001 商品實際到店日期 | |
StoreTime | 到店時間 | string | N | 若代碼為5000/5001 商品實際到店時間 |
4. 列印全家店到店冷凍(物流標籤)
說明
- 列印全家店到店冷凍物流單,列印期限訂單成立D+7
傳遞方式:Http POST method
API URL:/Member/Order/PrintFamiFreezingC2CLabel
Request
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
LogisticNumbers | Paynow物流單號組成的字串 | string | Y | Paynow物流單號 +,+ 物流單子序號多筆之間用 , 區隔 EX:ABCD0017B21903001221, ABCD0017B21903001270 |
Response
回傳列印物流標籤畫面
5. 重新取號
說明
- 依商家原有訂單資料進行重新取號(PayNow 物流單號、配送編號)
- 重新取號規則
1. 已獲取出貨單號且訂單狀態為成立中,且買家尚未取貨
傳遞方式:Http POST method application/x-www-form-urlencoded
API:URL/api/Orderapi/ReNewOrder
Request
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
JsonOrder | 物流單資料 | string | Y | 以下資料組成Object後轉換JsonString以TripleDESEncoding加密後urlencode傳送附錄 |
Json Content
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
user_account | 商家主帳號 | string | 10 | Y | |
LogisticNumber | Paynow物流單號 | string | 20 | Y | |
sno | 物流單序號 | int | Y | ||
OrderNo | 商家訂單編號 | string | 27 | Y | 商家原始訂單編號 |
TotalAmount | 訂單總金額 | string | 5 | Y | |
apicode | 商家api密碼 | string | 30 | Y | |
PassCode | 傳遞碼 | string | Y | 以下參數值依序組合成一段字串(不包含+號)user_account + OrderNo + TotalAmount + apicode並使用sha-1雜湊函數取得組合字串的雜湊值 附錄 | |
ReservedNo | 保留編號 | string | 20 | Y | 電子地圖回傳保留編號 |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
Status | 狀態 | string | 1 | Y | S:成功 F:失敗 |
LogisticNumber | PayNow物流單號 | string | 20 | Y | |
OrderNo | 商家原始訂單編號 | string | 27 | Y | |
sno | 物流單序號 | int | Y | ||
paynoworderno | 新訂單編號 | string | 30 | Y | 商家原始訂單編號 |
paymentno | 物流商貨運編號 | string | Y | 重新取號後新的商家訂單編號,請以此訂單編號作為批次列印與查詢的訂單編號 | |
ErrorMsg | 錯誤訊息 | string | Y | 成功則為null |
Objec Example
Request Object
{
"LogisticNumber":"MIJA002FR22112156425",
"OrderNo": "211215145423",
"apicode": "12345678",
"TotalAmount": "200",
"user_account": "28229955",
"PassCode": "E73247AE62604CD2EF7EFC08480C4E7F41852C8C",
"sno": "1",
"ReservedNo": "21120300000000518072"
}
Response Object
{
"LogisticNumber":"MIJA002FR22112159716", "OrderNo":"211215145423",
"paynoworderno":"211215145423_R1",
"sno":"1",
"paymentno":"11000094962",
"Status":"S",
"ErrorMsg":null
}
6. 全家店號轉換
說明
- 轉換全家現行店號/原始店號
傳遞方式:Http GET method application/x-www-form-urlencoded
API:/api/FamiFreezingC2C/GetFamiFreezingStoreID
Request
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
storeId | 店號 | string | 6 | Y | |
IDtype | 轉換類型 | string | 1 | Y | 1:轉換成現行店號 2:轉換成原始店號 |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
storeId | 狀態 | string | 6 | Y | |
IDtype | 轉換類型 | string | 1 | Y | |
Error | 錯誤訊息 | string | Y | 沒有錯誤則為空值 |
Response Object
{
"storeId": "017206",
"IDtype": "1",
"Error": ""
}
7. 取消物流單
說明
- 將該張物流單更改為無效訂單
- 取消後保留編號將無法使用、已出貨無法取消
傳遞方式:Http DELETE method application/x-www-form-urlencoded
API URL:/api/Orderapi/CancelOrder
Request
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
LogisticNumber | Paynow物流單號 | string | 20 | Y | |
sno | 物流單序號 | int | Y | ||
PassCode | 傳遞碼 | string | Y | 以下參數值依序組合成一段字串(不包含+號)user_account + OrderNo + TotalAmount + apicode並使用sha-1雜湊函數取得組合字串的雜湊值 附錄 |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
string | Y | 純字串 S成功回傳: S,訂單已取消 失敗回傳:F,訂單取消失敗失敗原因: 失敗原因 |
8. 查詢物流單(PayNow物流單號)
說明
- 根據PayNow物流單號查詢物流單資訊
傳遞方式:Http GET method
API URL:/api/Orderapi/Get_Order_Info
Request
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
LogisticNumber | PayNow物流單號 | string | 20 | Y | |
sno | 物流單序號 | int | Y | 固定為1 |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
LogisticNumber | PayNow物流單號 | string | 20 | Y | |
sno | 物流單序號 | string | Y | ||
orderno | 商家訂單編號 | string | 30 | Y | |
Logistic_Serviece | 物流服務 | string | 2 | Y | 23:全家店到店物流(冷凍) |
Status | 狀態 | string | 1 | Y | 0:成立中訂單 1:無效訂單 |
Delivery_Status | 物流狀態 | string | 2 | Y | 流程狀態描述 |
PayNowLogisticCode | 物流代碼 | string | 4 | Y | PayNow物流代碼 |
Detail_Status_Description | 物流代碼描述 | string | Y | PayNow物流代碼詳細資訊 | |
paymentno | 物流商託運單號 | string | Y | ||
ErrorMsg | 錯誤訊息 | string | Y | Null則為查詢成功 |
Objec Example
Request Object
{
"LogisticNumber":"MIJA0027B22112100002",
"sno":"1",
}
Response Object
{
"LogisticNumber":"MIJA002FR22112156425",
"orderno":"211215145423",
"Logistic_Serviece":"23",
"Status":"0",
"Delivery_Status":"等待寄件",
"PayNowLogisticCode":"0000",
"Detail_Status_Description":"等待寄件",
"sno":"1",
"ErrorMsg":null,
"paymentno":"11000094930"
}
9. 查詢物流單(商家訂單編號)
說明
- 查詢物流單(商家訂單編號)
傳遞方式:Http GET method
API URL:/api/Orderapi/Get_Order_Info_orderno
Request
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
orderno | 商家訂單編號 | string | 30 | Y | |
user_account | 商家主帳號 | string | 10 | Y | |
sno | 物流單序號 | int | Y | 固定為1 |
Response
參數 | 名稱 | 型態 | 長度 | 必須 | 備註 |
---|---|---|---|---|---|
LogisticNumber | PayNow物流單號 | string | 20 | Y | |
sno | 物流單序號 | string | Y | ||
orderno | 商家訂單編號 | string | 30 | Y | |
Logistic_Serviece | 物流服務 | string | 2 | Y | 23:全家店到店物流(冷凍) |
Status | 狀態 | string | 1 | Y | 0:成立中訂單 1:無效訂單 |
Delivery_Status | 物流狀態 | string | 2 | Y | 流程狀態描述 |
PayNowLogisticCode | 物流代碼 | string | 4 | Y | PayNow物流代碼 |
Detail_Status_Description | 物流代碼描述 | string | Y | PayNow物流代碼詳細資訊 | |
paymentno | 物流商託運單號 | string | Y | ||
ErrorMsg | 錯誤訊息 | string | Y | Null則為查詢成功 |
Objec Example
Request Object
{
"orderno":"1630206584255",
"user_account":"28229955",
"sno":"1",
}
Response Object
{
"LogisticNumber":"MIJA002FR22112156425",
"orderno":"211215145423",
"Logistic_Serviece":"23",
"Status":"0",
"Delivery_Status":"等待寄件",
"PayNowLogisticCode":"0000",
"Detail_Status_Description":"等待寄件",
"sno":"1",
"ErrorMsg":null,
"paymentno":"11000094930"
}
FamiFreezingC2C物流貨態代碼
貨態代碼 | 貨態描述 |
---|---|
0000 | 訂單已成立 等待出貨 |
0101 | 商品已到寄件門市 |
0102 | 門市已更新寄件中 |
0103 | 門市已更新退件中 |
4000 | 進驗成功 |
4005 | 商品多標籤 |
4007 | 商品捆包已退 |
4031 | 商品破損退貨中 |
4032 | 商品超才退貨中 |
4039 | 無標籤 |
4040 | 條碼資料錯誤 |
4041 | 貨件破損已退 |
4042 | 包裝凹折已退 |
4043 | 冷凍件已退 |
4044 | 到貨後訂單刪除 |
4045 | 貨件曾重複出貨 |
4046 | 禁運品已退 |
4061 | 商品遺失 |
4063 | 包裹異常不配送 |
4067 | 小物流遺失 |
4068 | 門市遺失 |
4069 | 包裝廠不良 包裝廠不良 (滲漏 ) |
4070 | 門市反應商品包裝不良(滲漏) |
4071 | 門市關店 |
4072 | 條碼資料重複 |
4073 | 7日內未寄件單號失效 |
4074 | 貨物進店後發生異常提早退貨 |
4533 | 商品超重 |
4633 | 超重需退貨 |
4703 | 貨件銷毀 |
4803 | 商品捆包待廠商回覆 |
4805 | 商品多標籤待廠商回覆 |
4832 | 超材需退貨 |
4839 | 無標籤待廠商回覆 |
4840 | 條碼資料錯誤待廠商回覆 |
4841 | 貨件破損待廠商回覆 |
4842 | 包裝凹折待廠商回覆 |
4843 | 誤進冷凍件需退貨 |
4844 | 到貨時訂單刪除待廠商回覆 |
4845 | 貨件曾重複出貨待廠商回覆 |
4846 | 禁運品需退貨 |
4863 | 包裹異常不配送待廠商回覆 |
4869 | 貨件濕損待廠商回覆 |
4871 | 門市關店待廠商回覆 |
4872 | 條碼資料重複待廠商回覆 |
4941 | 貨件破損進入賠償程序 |
4963 | 異常已個案賠償 |
5000 | 取件門市配達 |
5001 | 退件門市配達 |
5200 | 商品運送中 |
6004 | 商品退回物流中心 |
7101 | 取件門市關轉店 |
7201 | 退件門市關轉店 |
8000 | 買家已取件 |
8002 | 退至全家總倉 |
8010 | 買家已取件-代收金額錯誤 |
8020 | 買家已取件商品有誤 |
8100 | 賣家已取件 |
8110 | 賣家已取件-代收金額錯誤 |
8120 | 賣家已取件商品有誤 |
9411 | 貨態停滯 |
貨態代碼流變動程 |
---|
一般出貨流程(成功取件) |
0101->5200->5000->8000 |
一般出貨流程(退貨成功) |
0101->5200->5000->6004->5001->8100 |